XS2A.pay

Payments Refund/Payout Endpoint max. 1000 Transactions per File.

The payout & refund feature with the endpoint multi offers the possibility to initiate a payout or refund that are based on XS2A.pay transactions. Several SEPA pain files can be created that can be processed by your bank.

post/payments/refundPayout/multi

Request

Base URL
https://api.xs2a.com/v1
Auth
HTTP basic
TypeScript
https://skmtc.dev/xs2a/apis/xs2a-api/docs/payments/refundPayout/multi/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

transaction_per_fileinteger required

The minimum value is 100 and the maximum value is 1000.

Example request

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

Response

Request successfully processed

message_idsstring[] required

Example response

{
  "message_ids": [
    "XFECURW7-payment-6075917565324"
  ]
}

Changes

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