Billing Transactions
A Billing Transaction describes a transaction on your invoice such as a payment or refund.
GET /api/v1/billing/billing_transactions/{id}GET /api/v1/billing/billing_transactions
Retrieve a Billing Transaction
GET /api/v1/billing/billing_transactions/{id}
Retrieves the details of a Billing Transaction.
ID of the Billing Transaction object.
The total amount of this billing transaction.
ID of the Billing Customer who is making this Billing Transaction
Time when this billing transaction was cancelled.
Time when this billing transaction was created.
The currency of the Billing Transaction in 3-letter ISO-4217 format.
ID of the Payment Intent associated with the Billing Transaction.
ID of the Billing Transaction object.
ID of the Invoice this billing transaction is associated with.
ID of the linked payment account to collect payment. You can find this ID in the Airwallex web app > Settings > Account details, within the Account Information section.
A set of string key-value pairs that you can attach to this object for storing additional information.
Returns true if the billing transaction was manually marked as succeeded, returns false if the transaction hasn't succeeded yet or was processed on Airwallex.
ID of the Payment Source for which this billing transaction is made.
Status of the billing transaction, one of CREATED, SUCCEEDED, CANCELLED and FAILED.
The time that the billing transaction succeeded.
Type of the billing transaction. One of PAYMENT or REFUND.
Time when this billing transaction was last updated.
| Error status | Description |
|---|---|
| 400 | Bad Request. Possible error codes: |
| 401 | Unauthorized. Possible error codes: |
| 404 | Not Found. Possible error codes: |
| 500 | Server Error. Possible error codes: |
$curl --request GET \> --url 'https://api.sandbox.airwallex.com/api/v1/billing/billing_transactions/billing_transaction_id' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json'
1{2 "amount": 19.99,3 "billing_customer_id": "bcus_hkpd7fedfgb004apkvs",4 "cancelled_at": "2023-06-15T12:30:00+0000",5 "created_at": "2023-06-15T12:30:00+0000",6 "currency": "USD",7 "external_id": "int_e65tkXCSzJrsMpTrzoFrjaau53",8 "id": "btxn_hkst2n8dxh3h6vaiq9i",9 "invoice_id": "inv_hkpd49cskgblns6iimw",10 "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg",11 "metadata": {12 "order_id": "ORD-12345"13 },14 "out_of_band": false,15 "payment_source_id": "psrc_sgstvjkjjh7lzraf39f",16 "status": "SUCCEEDED",17 "succeeded_at": "2023-06-15T12:35:01+0000",18 "type": "PAYMENT",19 "updated_at": "2023-06-15T12:30:00+0000"20}
List all Billing Transactions
GET /api/v1/billing/billing_transactions
Retrieves a list of Billing Transactions based on the query parameters.
ID of the Invoice this Billing Transaction is associated with.
The start date of created_at in ISO8601 format (inclusive).
A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call. To retrieve the next page of results, pass the value of page_after (if not null) from the response to a subsequent call. To retrieve the previous page of results, pass the value of page_before (if not null) from the response to a subsequent call.
Number of Billing Transactions per page. Defaults to 20.
The end date of created_at in ISO8601 format (exclusive).
Paged results.
The total amount of this billing transaction.
ID of the Billing Customer who is making this Billing Transaction
Time when this billing transaction was created.
The currency of the Billing Transaction in 3-letter ISO-4217 format.
ID of the Billing Transaction object.
Status of the billing transaction, one of CREATED, SUCCEEDED, CANCELLED and FAILED.
Time when this billing transaction was last updated.
Time when this billing transaction was cancelled.
ID of the Payment Intent associated with the Billing Transaction.
ID of the Invoice this billing transaction is associated with.
ID of the linked payment account to collect payment. You can find this ID in the Airwallex web app > Settings > Account details, within the Account Information section.
A set of string key-value pairs that you can attach to this object for storing additional information.
Returns true if the billing transaction was manually marked as succeeded, returns false if the transaction hasn't succeeded yet or was processed on Airwallex.
ID of the Payment Source for which this billing transaction is made.
The time that the billing transaction succeeded.
Type of the billing transaction. One of PAYMENT or REFUND.
The page cursor used for searching after page.
The page cursor used for search before page.
| Error status | Description |
|---|---|
| 400 | Bad Request. Possible error codes: |
| 401 | Unauthorized. Possible error codes: |
| 500 | Server Error. Possible error codes: |
$curl --request GET \> --url 'https://api.sandbox.airwallex.com/api/v1/billing/billing_transactions' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json'
1{2 "items": [3 {4 "amount": 19.99,5 "billing_customer_id": "bcus_hkpd7fedfgb004apkvs",6 "cancelled_at": "2023-06-15T12:30:00+0000",7 "created_at": "2023-06-15T12:30:00+0000",8 "currency": "USD",9 "external_id": "int_e65tkXCSzJrsMpTrzoFrjaau53",10 "id": "btxn_hkst2n8dxh3h6vaiq9i",11 "invoice_id": "inv_hkpd49cskgblns6iimw",12 "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg",13 "metadata": {14 "order_id": "ORD-12345"15 },16 "out_of_band": false,17 "payment_source_id": "psrc_sgstvjkjjh7lzraf39f",18 "status": "SUCCEEDED",19 "succeeded_at": "2023-06-15T12:35:01+0000",20 "type": "PAYMENT",21 "updated_at": "2023-06-15T12:30:00+0000"22 }23 ],24 "page_after": "<string>",25 "page_before": "<string>"26}