Sign in
General

Pay out from an account to the account holder

Pays out a specified amount from an account to the bank account of account holder.

post/payoutAccountHolder

Request body

accountCodestring required

The code of the account from which the payout is to be made.

accountHolderCodestring required

The code of the Account Holder who owns the account from which the payout is to be made. The Account Holder is the party to which the payout will be made.

bankAccountUUIDstring

The unique ID of the Bank Account held by the Account Holder to which the payout is to be made. If left blank, a bank account is automatically selected.

descriptionstring

A description of the payout. Maximum 200 characters. Allowed: abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789/?:().,'+ ";

merchantReferencestring

A value that can be supplied at the discretion of the executing user in order to link multiple transactions to one another.

Response

OK - the request has succeeded.

bankAccountUUIDstring

The unique ID of the Bank Account to which the payout was made.

merchantReferencestring

The value supplied by the executing user when initiating the transfer; may be used to link multiple transactions.

pspReferencestring

The reference of a request. Can be used to uniquely identify the request.

resultCodestring

The result code.

submittedAsyncboolean

Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:

  • true: The request is queued and will be executed when the providing service is available in the order in which the requests are received.
  • false: The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.

Changes

Changed in 11 of the 23 revisions of this API.22124

  • v340f3741a64839See the full diff
    • ▲

      the request's body type/format changed from / to object/

      request-body-type-changed

    • ▲

      the amount request property type/format changed from / to object/

      request-property-type-changed

    • ▲

      the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • ▲

      the response's body type/format changed from / to object/ for status 202

      response-body-type-changed

    • ▲

      the response's body type/format changed from / to object/ for status 400

      response-body-type-changed

    • ▲

      the response's body type/format changed from / to object/ for status 401

      response-body-type-changed

    • ▲

      the response's body type/format changed from / to object/ for status 403

      response-body-type-changed

    • ▲

      the response's body type/format changed from / to object/ for status 422

      response-body-type-changed

    • ▲

      the response's body type/format changed from / to object/ for status 500

      response-body-type-changed

  • v3e6e17afe575d1See the full diff
    • ○

      the description request property's maxLength was increased from 35 to 200

      request-property-max-length-increased

  • v39a84353194df1See the full diff
    • ○

      the request property amount became optional

      request-property-became-optional

  • v3f451762264261See the full diff
    • ○

      api tag General added

      api-tag-added

  • v3e38d0becc3862See the full diff
    • ○

      the endpoint scheme security ApiKeyAuth was added to the API

      api-security-added

    • ○

      the endpoint scheme security BasicAuth was added to the API

      api-security-added

  • v3a5193c3dc8525See the full diff
    • ○

      added the optional property status to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property status to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property status to the response with the 403 status

      response-optional-property-added

    • ○

      added the optional property status to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property status to the response with the 500 status

      response-optional-property-added

  • v3715a89b2412c1See the full diff
    • ●

      the description request property's maxLength was set to 35

      request-property-max-length-set

  • v3ce23a0d8c0486See the full diff
    • ○

      added the media type application/json for the response with the status 400

      response-media-type-added

    • ○

      added the media type application/json for the response with the status 401

      response-media-type-added

    • ○

      added the media type application/json for the response with the status 403

      response-media-type-added

    • ○

      added the media type application/json for the response with the status 422

      response-media-type-added

    • ○

      added the media type application/json for the response with the status 500

      response-media-type-added

    • ○

      added the success response with the status 202

      response-success-status-added

  • v352572967b37d21See the full diff
    • ▲

      the response property pspReference became optional for the status 200

      response-property-became-optional

    • ▲

      the response property submittedAsync became optional for the status 200

      response-property-became-optional

    • ○

      api operation id post-payoutAccountHolder was added

      api-operation-id-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v3f8f2ad20c7f61See the full diff
    • ▲

      the response property bankAccountUUID became optional for the status 200

      response-property-became-optional