XS2A.pay

Generates a pain file.

The payout & refund feature offers the possibility to initiate a payout or refund that are based on XS2A.pay transactions. A SEPA pain file is created that can be processed by your bank.

post/payments/refundPayout

Request

Base URL
https://api.xs2a.com/v1
Auth
HTTP basic
TypeScript
https://skmtc.dev/xs2a/apis/xs2a-api/docs/payments/refundPayout/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

pain_type'pain.001.001.03' required

The format of pain file.

batch_bookingboolean

Example request

{
  "pain_type": "pain.001.001.03",
  "transactions": [
    {
      "transaction": "10003-xp-911h-mv99",
      "amount": 10.02,
      "type": "payout"
    }
  ]
}

Response

Request successfully processed

message_idstring required

The message id to get the pain file.

Example response

{
  "message_id": "XFECURW7-payment-6075917565324"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.