A payment's status is Succeeded, Failed, or Unknown (see Sandbox vs Production). Unknown must be resolved via reconcile — never retried directly.
GET/api/Payment— List payments
| Property | Value |
|---|
| Required scope | payments:read |
| Idempotency-Key | Not required |
| Parameter | In | Type | Required |
|---|
page | query | integer (int32) | |
pageSize | query | integer (int32) | |
orderBy | query | string | |
orderDirection | query | string | |
createdFrom | query | string (date-time) | |
createdTo | query | string (date-time) | |
GET/api/Payment/{paymentId}— Retrieve a single payment
| Property | Value |
|---|
| Required scope | payments:read |
| Idempotency-Key | Not required |
| Parameter | In | Type | Required |
|---|
paymentId | path | string | Required |
POST/api/Payment/{paymentId}/Attempt— Simulate a charge attempt in Sandbox (requires Idempotency-Key)
| Property | Value |
|---|
| Required scope | payments:write |
| Idempotency-Key | Required |
| Financial mutation | Yes — moves money |
| Parameter | In | Type | Required |
|---|
paymentId | path | string | Required |
POST/api/Payment/{paymentId}/Reconcile— Resolve an unknown payment's final outcome (requires Idempotency-Key)
| Property | Value |
|---|
| Required scope | payments:write |
| Idempotency-Key | Required |
| Financial mutation | Yes — moves money |
| Parameter | In | Type | Required |
|---|
paymentId | path | string | Required |
ReBate Pay Docs