API to retrieve the detail of a specific payment

Responses

200 OK

  • id [string]: Unique ID of the payment.
  • code_identifier [string]: Generated code identifier
  • type [string]: Type of payment (TO_BUSINESS or REFUND_TO_BUSINESS)
  • amount_unit [number]: Amount of the payment in cents
  • currency [string]: Currency of the payment
  • status [string]: Status of the payment (PENDING, ACCEPTED or CANCELED)
  • expired [boolean]: If true, the payment is expired
  • metadata [object]: Additional metadata of the payment
  • sender [object]: The sender actor of the payment
    • id [string]: Unique ID of the sender
    • type [string]: Type of the actor (CONSUMER)
    • name [string]: Short name of the actor
  • receiver [object]: The receiver actor of the payment
    • id [string]: Unique ID of the receiver
    • type [string]: Type of the actor (SHOP)
  • daily_closure [object]: The daily closure of the payment
    • id [string]: ID of the daily closure
    • date [string]: The closure date
  • insert_date [datetime]: Timestamp of payment insertion
  • expire_date [datetime]: Timestamp of payment expiration
  • external_code [string]: Order ID or payment external identifier

403 Forbidden or invalid authorization header

  • code [integer]: Error code
  • message [string]: Error message

404 Resource not found

  • code [integer]: Error code
  • message [string]: Error message

🚧

RETRY

If the API returns any of the possible error, like a 500, this doesn't mean that the payment might not be ACCEPTED already.
If you get the error we suggest to execute a retry within few seconds and if still not getting a response execute an Update Payment with the CANCEL_OR_REFUND flow.

Language