Sign in
XS2A.pay

Change the payment status of a transaction to received

post/payments/{transaction-id}/received

Path parameters

transaction-idstring required

Response

Payment Object with the updated payment_status

idstring

Transaction id

transactionstring

Internal XS2A transaction id. This id will be the same for the whole transaction

sender_holderstring

Account holder of the sender account

sender_ibanstring

IBAN of the sender account

sender_bicstring

BIC of the sender account

sender_bank_namestring

Name of the sender bank

sender_country_id'DE' | 'AT' | 'CH'

The 2-letter country code

recipient_holderstring

Account holder of the recipient account

recipient_ibanstring

IBAN of the recipient account

recipient_bicstring

BIC of the recipient account

recipient_bank_namestring

Name of the recipient bank

recipient_country_id'DE' | 'AT' | 'CH'

The 2-letter country code

purposestring

Purpose of transfer

amountnumber float

Amount to transfer

currency_id'EUR' | 'CHF'

The id of the currency to be used.

testmodestring

Indicates whether or not it is a test transaction

payment_status'NONE' | 'RECEIVED' | 'LOSS'

Payment status of the transaction. By default, this will be NONE and will not automatically be set to anything else, unless you are using the account reconciliation feature, or you are changing it yourself (either via the dashboard or the API). The status NONE means that the payment was initiated but not found on the recipient account (default value). The status RECEIVED means that the payment was found on the recipient account, which is determined either by the mentioned reconciliation feature or manually by you. LOSS means, that the payment has not been found on the recipient account after >= 5 days. Maintaining clean and accurate tracking of payment_status helps you with fraud prevention. It allows you to specify rules in our fraud prevention tool (e.g. how many pending transactions (status NONE) you allow from a certain bank account.)

metadataMetadata nullable

An array of data which will be passed back to your application. With this field you can for example pass information about your customer ids, order ids and the like back to your application. Please beware of some restrictions for the metadata field: maximum of 3 values, maximum of a key length of 20 characters, maximum length of values is 128 characters. For privacy protection reason it is not allowed to use this field for transferring personal data (e.g. names or addresses).

merchant_idstring

Data will be returned unchanged

objectstring

Object type, in this case a xs2a_payment

Example response

{
  "id": "xp_fSdkfjS2R2S5x1pu",
  "transaction": "10001-xp-abcd-abcd",
  "sender_holder": "Holder Customer",
  "sender_iban": "DE62888888880012345678",
  "sender_bic": "TESTDE88XXX",
  "sender_bank_name": "Testbank",
  "sender_country_id": "DE",
  "recipient_holder": "Holder",
  "recipient_iban": "DE62888888880012345678",
  "recipient_bic": "TESTDE88XXX",
  "recipient_bank_name": "Testbank",
  "recipient_country_id": "DE",
  "purpose": "Purpose",
  "amount": 10.99,
  "currency_id": "EUR",
  "testmode": "1",
  "payment_status": "RECEIVED",
  "metadata": {
    "key1": "value1"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.