AIairtm
Operations

Get operation by code

This endpoint will return an operation corresponding to the specified code used to create a payout.

getcode/{code}

Request

Path parameters

codestring

Response

OK

idstring

Unique identifier automatically generated on operation creation.

partner_idstring

ID of the partner who created and committed the operation.

statusstring

The status of the operation. Please refer to the Purchases and Payments endpoints to see possible statuses.

amountstring

Amount in USD that was transacted in the operation.

descriptionstring

Description of the operation, inputted in the creation.

confirmation_uristring

Deprecated. Airtm no longer calls this URL, and new payout requests that include it are rejected. Use webhooks instead.

cancel_uristring

Deprecated. Airtm no longer calls this URL, and new payout requests that include it are rejected. Use webhooks instead.

codestring

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

airtm_operation_idstring

Unique identifier for the payout operation within the Airtm system.

created_atstring

Datetime of operation creation.

updated_atstring

Datetime of latest change in the operation.

airtm_user_idstring

The ID of the user involved in the payout/purchase.

airtm_user_emailstring

The email of the user involved in the payout/purchase in Airtm.

operation_typestring

Type of operation, can be 'purchase' or 'payout'.

failure_uristring

Deprecated. Airtm no longer calls this URL, and new payout requests that include it are rejected. Use webhooks instead.

failure_reasonstring

This populates with the reason the operation failed.

callback_uristring

Deprecated. Airtm no longer calls this URL, and new purchase requests that include it are rejected. Use webhooks instead.

airtm_operation_hashstring

Unique hash for the payout operation within the Airtm system.

Example response

{
  "id": "5c55efac-2e10-4511-918b-8a27271c074e",
  "partner_id": "2c3e7d5e-0cfb-411f-9e34-78ba4d3b8ce7",
  "status": "COMPLETED",
  "amount": "1.00",
  "description": "Payout test",
  "confirmation_uri": "http://your.site/payout/success",
  "airtm_operation_id": "1e1042ac-acae-4e7f-91ae-6d4589f8ac9c",
  "created_at": "2023-06-13T23:37:53.471Z",
  "updated_at": "2023-06-13T23:40:09.569Z",
  "airtm_user_id": "3c4ca4b7-36d4-4d05-bb86-12512644c901",
  "airtm_user_email": "john.doe@gmail.com",
  "operation_type": "payout",
  "failure_uri": "http://your.site/payout/failure",
  "airtm_operation_hash": "ACAEBV4E7FNE91AE"
}

Changes

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