Create Payout Request
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Amount to be sent in COP. Must be greater than $1.000. The maxiumum is configured per merchant but defaults to $5.000.000. Contact us if you need to increase this limit.
Payout Target to send money to.
Reference sent in by merchant to identify Payout Request.
An optional account ID of the source merchant account for this Payout Request.
Response
Amount to send to the customer’s Payout Target.
Amount sent by Payout Request. Starts at amount and changes to 0 if cancelled.
ISO string indicating when the Payout Request was created.
Details about the customer who owns the Payout Target for which the Payout Request was created.
Reference to customer who owns the Payout Target for which the Payout Request was created.
Fee charged for the transaction. This fee will be subtracted from amountCollected at settlement time.
Unique identifier for this Payout Request.
Details about the Payout Target for which the Payout Request was created.
Reference to the Payout Target for which the Payout Request was created.
Reference sent in by merchant to identify Payout Request.
Reference to Merchant Account. Safe to ignore if Merchant Accounts are not being used.
Status of the Payout Request.
processing, approved, cancelled Additional detail on the status. Only present when status is "cancelled".
AUTHENTICATION_FAILED, CUSTOMER_CANCELLATION, DECLINED_BY_BANK, EXPIRED, INVALID_ACCOUNT, NOT_ENOUGH_FUNDS, ERROR ISO string indicating when the Payout Request was last updated.