AIairtm
Payins

Get payin by code

Get the details of an existing payin by its code.

get/payins/by-code/{code}

Request

Path parameters

codestring required

The payin code

Response

Ok

idstring uuid required
codestring required

An arbitrary string of the partner’s choosing. Used to identify and correlate Airtm purchases with partner records.

[!important] Must be a unique.

hashstring

Unique hash for the payin operation within the Airtm system.

status'CREATED' | 'CONFIRMED' | 'CANCELED' | 'PROCESSING' | 'FAILED' | 'BRIDGE_FAILED' | 'BRIDGE_CANCELED' required

The current status of the payin

  • CREATED: The payin has been created but not yet confirmed.
  • CONFIRMED: The payin has been confirmed and is ready for processing.
  • CANCELED: The payin has been canceled by the user or system.
  • PROCESSING: The payin is currently being processed.
  • FAILED: The payin has failed due to an error.
  • BRIDGE_FAILED: The payin has failed due to an error in Bridge.
  • BRIDGE_CANCELED: The payin has been canceled due to an error in Bridge.
amountnumber double required

Amount in USD that was transacted in the operation.

netAmountnumber double required

Amount in USD to be received by the enterprise

airtmFeenumber double required

Amount to be collected by Airtm as fee

descriptionstring required

A text string describing the purchase.

[!tip] This text is displayed to the user when they are confirming the transaction.

airtmUserIdstring uuid
airtmUserEmailstring
failureReasonstring

If the payin failed to complete, this field will describe why it failed.

createdAtstring date-time required

Timestamp of when the payin was created.

updatedAtstring date-time required

Timestamp of the last update made to the payin.

confirmationUristring url required

A URL to redirect the user to when they confirm the transaction.

cancelUristring url required

A URL to redirect the user to when they cancel the transaction.

Example response

{
  "amount": 10,
  "netAmount": 9.5,
  "airtmFee": 0.5,
  "items": [
    {
      "amount": 10,
      "quantity": 1
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.