Payout

Fields every transaction has — payin, refund and payout. object and method_type tell which fields come on top; the fields of the payment instrument are in an object named after it — card, apple_pay or google_pay.
- amount
  Type:
  required
  Properties: 2
- created_at
  Type: stringFormat: date-time
  required
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- id
  Type: stringFormat: uuid
  required
  
  Transaction id. The type of the transaction is in object.
- merchant_reference
  Type:
  min length:
  1
  max length:
  100
  required
  
  Your id for the transaction, unique per merchant across payins, refunds, payouts and pay sessions. It is also the idempotency key of the create — the same reference with the same body returns the existing transaction, with a different body 409 merchant_reference_conflict. Never expires.
- method_type
  enum
  const:
  payout_card
  required
- object
  const:
  payout
  required
- status
  Type: enum
  required
  values
  created
  
  Recorded. Not final.
  
  processing
  
  Checks or provider in progress. Not final.
  
  completed
  
  Credited to the recipient. Final.
  
  failed
  
  Not credited — read status_details.code. The blocked amount is returned to the balance. Final.
- status_details
  Type: nullable
  required
  
  Why the transaction ended failed. null in every other status.
  
  Properties: 2
- updated_at
  Type: stringFormat: date-time
  required
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- card
  Type: object
  
  Set when method_type is payout_card.
  
  Properties: 2
- rrn
  Type: string
  
  Retrieval reference number of the payout in the card network, when the provider returns it. Lets the recipient's bank find the payment.

CreateCardPayoutRequest

Transaction