Brick API Documentation

Check Status

This SNAP Disbursement guide is currently available in English.

Retrieve the latest state of a Regular or BI-FAST transfer.

POST /v2/payments/disbursements/snap/status

Choose your transaction reference

Request: provide exactly one of originalReferenceNo or originalPartnerReferenceNo, together with the appropriate service code. Sending both lookup identifiers is rejected.

Response: a successful inquiry includes both original references, identifying the same transaction. They are not two separate transfers.

FieldTypeRequiredDescription
originalReferenceNostringConditionalBrick transaction reference. Supply this or originalPartnerReferenceNo, not both.
originalPartnerReferenceNostringConditionalYour original transfer reference. Supply this or originalReferenceNo, not both.
serviceCodestringYes01 for Regular; 02 for BI-FAST.

Transaction outcomes

StatelatestTransactionStatustransactionStatusDescMeaning
Completed00SuccessThe transfer completed successfully.
Processing03ProcessingThe transfer has not reached a final outcome.
Failed06FailedThe transfer reached a final failed outcome.

An inquiry does not change the outcome These examples show alternative outcomes for existing transactions. A successful inquiry returns HTTP 200 and responseCode 2000300 even when the transaction is Processing or Failed.

Request and response examples

Regular — completed

Status request · cURL

TerminalCode
curl --request POST \ --url '{{base_url}}/v2/payments/disbursements/snap/status' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer snap_demo_20261020_83ac67125b8f' \ --header 'X-CLIENT-KEY: 83ac6712-5b8f-4b0d-9e24-63aa79102d45' \ --header 'X-TIMESTAMP: 2026-10-20T09:00:00+07:00' \ --header 'X-SIGNATURE: U05BUC1ET0NTLUVYQU1QTEUtU0lHTkFUVVJFLU5PVC1GT1ItQVVUSA==' \ --header 'X-REFERENCE-ID: 91fd8e9b-4c37-4d5a-83bd-2b4589c0a622' \ --data-raw '{ "originalReferenceNo": "BRICK-REG-20261020-0001", "serviceCode": "01" }'

Response · HTTP 200

JSONCode
{ "responseCode": "2000300", "responseMessage": "Successful", "originalReferenceNo": "BRICK-REG-20261020-0001", "originalPartnerReferenceNo": "SNAP-REG-20261020-0001", "serviceCode": "01", "latestTransactionStatus": "00", "transactionStatusDesc": "Success" }

Regular — processing

Status request · cURL

TerminalCode
curl --request POST \ --url '{{base_url}}/v2/payments/disbursements/snap/status' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer snap_demo_20261020_83ac67125b8f' \ --header 'X-CLIENT-KEY: 83ac6712-5b8f-4b0d-9e24-63aa79102d45' \ --header 'X-TIMESTAMP: 2026-10-20T09:00:00+07:00' \ --header 'X-SIGNATURE: U05BUC1ET0NTLUVYQU1QTEUtU0lHTkFUVVJFLU5PVC1GT1ItQVVUSA==' \ --header 'X-REFERENCE-ID: 91fd8e9b-4c37-4d5a-83bd-2b4589c0a622' \ --data-raw '{ "originalReferenceNo": "BRICK-REG-20261020-0002", "serviceCode": "01" }'

Response · HTTP 200

JSONCode
{ "responseCode": "2000300", "responseMessage": "Successful", "originalReferenceNo": "BRICK-REG-20261020-0002", "originalPartnerReferenceNo": "SNAP-REG-20261020-0002", "serviceCode": "01", "latestTransactionStatus": "03", "transactionStatusDesc": "Processing" }

Regular — failed

Status request · cURL

TerminalCode
curl --request POST \ --url '{{base_url}}/v2/payments/disbursements/snap/status' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer snap_demo_20261020_83ac67125b8f' \ --header 'X-CLIENT-KEY: 83ac6712-5b8f-4b0d-9e24-63aa79102d45' \ --header 'X-TIMESTAMP: 2026-10-20T09:00:00+07:00' \ --header 'X-SIGNATURE: U05BUC1ET0NTLUVYQU1QTEUtU0lHTkFUVVJFLU5PVC1GT1ItQVVUSA==' \ --header 'X-REFERENCE-ID: 91fd8e9b-4c37-4d5a-83bd-2b4589c0a622' \ --data-raw '{ "originalReferenceNo": "BRICK-REG-20261020-0003", "serviceCode": "01" }'

Illustrative failed response · HTTP 200

JSONCode
{ "responseCode": "2000300", "responseMessage": "Successful", "originalReferenceNo": "BRICK-REG-20261020-0003", "originalPartnerReferenceNo": "SNAP-REG-20261020-0003", "serviceCode": "01", "latestTransactionStatus": "06", "transactionStatusDesc": "Failed", "errorCode": "5000100", "errorDetailCode": "general_error", "failureMessage": "General Error", "category": "Failed" }

This transfer has failed. Check errorCode, errorDetailCode, and failureMessage for the failure reason.

BI-FAST — completed

Status request · cURL

TerminalCode
curl --request POST \ --url '{{base_url}}/v2/payments/disbursements/snap/status' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer snap_demo_20261020_83ac67125b8f' \ --header 'X-CLIENT-KEY: 83ac6712-5b8f-4b0d-9e24-63aa79102d45' \ --header 'X-TIMESTAMP: 2026-10-20T09:00:00+07:00' \ --header 'X-SIGNATURE: U05BUC1ET0NTLUVYQU1QTEUtU0lHTkFUVVJFLU5PVC1GT1ItQVVUSA==' \ --header 'X-REFERENCE-ID: 91fd8e9b-4c37-4d5a-83bd-2b4589c0a622' \ --data-raw '{ "originalReferenceNo": "BRICK-BIF-20261020-0001", "serviceCode": "02" }'

Response · HTTP 200

JSONCode
{ "responseCode": "2000300", "responseMessage": "Successful", "originalReferenceNo": "BRICK-BIF-20261020-0001", "originalPartnerReferenceNo": "SNAP-BIF-20261020-0001", "serviceCode": "02", "latestTransactionStatus": "00", "transactionStatusDesc": "Success" }

BI-FAST — processing

Status request · cURL

TerminalCode
curl --request POST \ --url '{{base_url}}/v2/payments/disbursements/snap/status' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer snap_demo_20261020_83ac67125b8f' \ --header 'X-CLIENT-KEY: 83ac6712-5b8f-4b0d-9e24-63aa79102d45' \ --header 'X-TIMESTAMP: 2026-10-20T09:00:00+07:00' \ --header 'X-SIGNATURE: U05BUC1ET0NTLUVYQU1QTEUtU0lHTkFUVVJFLU5PVC1GT1ItQVVUSA==' \ --header 'X-REFERENCE-ID: 91fd8e9b-4c37-4d5a-83bd-2b4589c0a622' \ --data-raw '{ "originalReferenceNo": "BRICK-BIF-20261020-0002", "serviceCode": "02" }'

Response · HTTP 200

JSONCode
{ "responseCode": "2000300", "responseMessage": "Successful", "originalReferenceNo": "BRICK-BIF-20261020-0002", "originalPartnerReferenceNo": "SNAP-BIF-20261020-0002", "serviceCode": "02", "latestTransactionStatus": "03", "transactionStatusDesc": "Processing" }

BI-FAST — failed

Status request · cURL

TerminalCode
curl --request POST \ --url '{{base_url}}/v2/payments/disbursements/snap/status' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer snap_demo_20261020_83ac67125b8f' \ --header 'X-CLIENT-KEY: 83ac6712-5b8f-4b0d-9e24-63aa79102d45' \ --header 'X-TIMESTAMP: 2026-10-20T09:00:00+07:00' \ --header 'X-SIGNATURE: U05BUC1ET0NTLUVYQU1QTEUtU0lHTkFUVVJFLU5PVC1GT1ItQVVUSA==' \ --header 'X-REFERENCE-ID: 91fd8e9b-4c37-4d5a-83bd-2b4589c0a622' \ --data-raw '{ "originalReferenceNo": "BRICK-BIF-20261020-0003", "serviceCode": "02" }'

Illustrative failed response · HTTP 200

JSONCode
{ "responseCode": "2000300", "responseMessage": "Successful", "originalReferenceNo": "BRICK-BIF-20261020-0003", "originalPartnerReferenceNo": "SNAP-BIF-20261020-0003", "serviceCode": "02", "latestTransactionStatus": "06", "transactionStatusDesc": "Failed", "errorCode": "5000100", "errorDetailCode": "general_error", "failureMessage": "General Error", "category": "Failed" }

This transfer has failed. Check errorCode, errorDetailCode, and failureMessage for the failure reason.

Look up by partner reference

Alternative request · cURL

TerminalCode
curl --request POST \ --url '{{base_url}}/v2/payments/disbursements/snap/status' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer snap_demo_20261020_83ac67125b8f' \ --header 'X-CLIENT-KEY: 83ac6712-5b8f-4b0d-9e24-63aa79102d45' \ --header 'X-TIMESTAMP: 2026-10-20T09:00:00+07:00' \ --header 'X-SIGNATURE: U05BUC1ET0NTLUVYQU1QTEUtU0lHTkFUVVJFLU5PVC1GT1ItQVVUSA==' \ --header 'X-REFERENCE-ID: 61fd8e9b-4c37-4d5a-83bd-2b4589c0a621' \ --data-raw '{ "originalPartnerReferenceNo": "SNAP-REG-20261020-0001", "serviceCode": "01" }'

Supply only one lookup reference. A successful response includes both references.

Inquiry rate limit

For the same authenticated client and the same transaction:

  • A maximum of 5 Check Status requests is allowed within a 30-second window.
  • The 6th and subsequent requests within that window return HTTP 429 with responseCode: "4290300".
  • The limit applies only to the affected transaction. Other transactions under the same authenticated client remain unaffected and have their own inquiry limits.
  • Looking up the same transaction using originalReferenceNo or originalPartnerReferenceNo shares the same limit.

Wait for the affected transaction’s rate-limit window to reset before trying again.

Timeouts and unresolved transactions

If your transfer submission returns no usable response, look up the transaction using originalPartnerReferenceNo. A timeout does not prove a failed transfer. Do not create a replacement while its outcome remains unresolved.

See Error Handling for recovery guidance.

Last modified on