v1

latestOpenAPI 3.0.12026-08-0674476716.0 KB

Payouts

Initiate a payout

The POST /payouts endpoint initiates a payout.

post/payouts

Request body

Example request

{
  "initiation": {
    "description": "e49j-2145-sp17-k3h0",
    "refId": "9htio4a1sp2akdr1aa",
    "onBehalfOfId": "c5a863bc-86f2-4418-a26f-25b24c7983c7",
    "amount": {
      "value": "10.23",
      "currency": "EUR"
    },
    "debtor": {
      "accountId": "a12345"
    },
    "creditor": {
      "name": "Customer Inc.",
      "ultimateCreditorName": "Customer Inc.",
      "iban": "GB29NWBK60161331926819",
      "bic": "BOFIIE2D",
      "accountNumber": "12345678"
    }
  }
}

Response

Successful response

Example response

{
  "payout": {
    "id": "po:yj6sSEf7ZYFP8yxN6XWi1KkMEcB:2gFUX1NDget",
    "bankTransactionId": "2UhwCZ3BMaEcAUK8bZdukor7NL4tH6TBuu6aJMp5KKfX:5zKcENpV",
    "memberId": "m:123456abcd:abcd",
    "createdDateTime": "2017-04-05T10:43:07.000+00:00",
    "updatedDateTime": "2017-04-05T10:45:07.000+00:00",
    "status": "INITIATION_COMPLETED",
    "bankPaymentStatus": "ACPC",
    "statusReasonInformation": "The payment is settled on debtor side.",
    "initiation": {
      "description": "payout for some reason",
      "refId": "9htio4a1sp2akdr1aa",
      "amount": {
        "value": "10.23",
        "currency": "EUR"
      },
      "debtor": {
        "accountId": "a12345"
      },
      "creditor": {
        "name": "Customer Inc.",
        "ultimateCreditorName": "Customer Inc.",
        "iban": "GB29NWBK60161331926819",
        "bic": "BOFIIE2D",
        "accountNumber": "12345678"
      }
    }
  }
}