Payments - Status
This API allows you to check the current status of a payment request
Note:
This is a Client Authorized call.
Check Payment Status
GET https://app.sign2pay.com/api/v2/payment/status/55fac963e6db9909ba000003| Parameter | Required | Type | Description |
|---|---|---|---|
| purchase_id | yes | String | The purchase id issued to your successful Payment Request. |
Request Headers & Body
Accept: */*
Accept-Encoding: gzip, deflate
Content-Type: application/json
Authorization: Basic YzUwOWZkNTkzNzQyYjZiMDhhZGY0ZjBiNDFhNDgwMWM6YTVjMWQyN2U0MGEzMGRkNjA2OTgyNTc4MWEyYWJlNGY=
Accept-Language: en-us
Response Body
{
"status": "PROCESSING"
}
Check Payment Status via Search
If you do not have the purchase_id associated with your payment, this API allows you to check the current status of a payment request by submitting the ref_id you sent when requesting the original payment.
GET https://app.sign2pay.com/api/v2/payment/search/55fac963e6db9909ba000003| Parameter | Required | Type | Description |
|---|---|---|---|
| ref_id | yes | String | The ref_id sent with your originial Payment Request. |
Request Headers & Body
Accept: */*
Accept-Encoding: gzip, deflate
Content-Type: application/json
Authorization: Basic YzUwOWZkNTkzNzQyYjZiMDhhZGY0ZjBiNDFhNDgwMWM6YTVjMWQyN2U0MGEzMGRkNjA2OTgyNTc4MWEyYWJlNGY=
Accept-Language: en-us
Response Body
{
"status": "PROCESSING",
"purchase_id": "56aa84950652684e550001b0"
}
Payment Status
| Status | Description |
|---|---|
| PROCESSING | Payment has been authorized and accepted for processing. |
| COMPLETE | Funds have been successfully obtained from the consumers account. |
| FAILED | Sign2Pay was unable to authorize this payment. |
| TIMEOUT | Sign2Pay was unable to authorize this payment within an hour of the beginning of the payment flow. |
| CANCELLED | Sign2Pay or merchant has cancelled this payment before processing began. |
| REFUNDED | Sign2Pay or merchant has refunded this payment. |