The GET /payments call allows your platform to look up a collection of payments.
previous required | string or null An opaque path for the previous page of results. You can perform an HTTP GET to obtain the previous page. |
next required | string or null An opaque path for the next page of results. You can perform an HTTP GET to obtain the next page. |
required | Array of objects An array of payment objects. |
api_version | string |
INVALID_PARAMS
NOT_AUTHORIZED
UNEXPECTED_ERROR
{- "next": "/payments?page=QVFQNUFBRVhpWFpzUGwxdncxNXN5bFgxUWhOd2RkNjJjWjYvdXFkNTFwZFowYi9EM2hJS25IRVBpS1NybkwrSWRIZE9vd00xZjNsQ1Q4ZUlJTVJTd0VmVnVXd3VxK2N1MHJ3RUUrL0VFVXRneUFxTG41TW5lcUxxRGRtd2YvODlMbjdnamk2S21qSDBhRkVsYW1EMGZUalljVVFHUThjWTB2Rm1lbUdxd3R0WjVjZEFPejUyWU1sOGdTTXRWUT09",
- "previous": null,
- "api_version": "3.0",
- "results": [
- {
- "amount": 1000,
- "amount_refunded": 1000,
- "amount_disputed": 1000,
- "auto_capture": false,
- "capture_at": null,
- "create_time": 1510080179,
- "currency": "USD",
- "custom_data": null,
- "failure_reason": null,
- "fee_amount": 0,
- "id": "00000000-0000-0000-0000-0000767bf5cd",
- "order": null,
- "owner": {
- "id": "be2b42e5-b808-40ae-9bbe-3291ab493f57",
- "path": "/accounts/be2b42e5-b808-40ae-9bbe-3291ab493f57",
- "resource": "accounts"
}, - "path": "/payments/00000000-0000-0000-0000-0000767bf5cd",
- "payment_method": {
- "id": "00000000-6363-0000-0000-000008b93a6e",
- "path": "/payment_methods/00000000-6363-0000-0000-000008b93a6e",
- "resource": "payment_methods"
}, - "pending_reasons": [
- {
- "details": [ ],
- "reason_code": "PENDING_CAPTURE",
- "reason_message": "Payment pending capture."
}
], - "resource": "payments",
- "status": "pending",
- "authorization_code": "0224241",
- "txnr_app_fee": null,
- "txnr_merchant": null,
- "initiated_by": "none",
- "api_version": "3.0",
- "reference_id": "dfeb052b-ae8c-4a69-b909-8d9ecdd7c742"
}, - {
- "amount": 1000,
- "amount_refunded": 1000,
- "amount_disputed": 1000,
- "auto_capture": false,
- "capture_at": null,
- "create_time": 1510079535,
- "currency": "USD",
- "custom_data": null,
- "failure_reason": null,
- "fee_amount": 0,
- "id": "00000000-0000-0000-0000-00006fa82d45",
- "order": {
- "id": "be2b42e5-b808-40ae-9bbe-3291ab493f57",
- "path": "/orders/be2b42e5-b808-40ae-9bbe-3291ab493f57",
- "resource": "orders"
}, - "owner": {
- "id": "be2b42e5-b808-40ae-9bbe-3291ab493f57",
- "path": "/accounts/be2b42e5-b808-40ae-9bbe-3291ab493f57",
- "resource": "accounts"
}, - "path": "/payments/00000000-0000-0000-0000-00006fa82d45",
- "payment_method": {
- "id": "00000000-6261-5553-0000-0000000001b8",
- "path": "/payment_methods/00000000-6261-5553-0000-0000000001b8",
- "resource": "payment_methods"
}, - "pending_reasons": [
- {
- "details": [ ],
- "reason_code": "PROCESSING",
- "reason_message": "Payment is being processed."
}
], - "resource": "payments",
- "status": "pending",
- "authorization_code": "0224241",
- "txnr_app_fee": null,
- "txnr_merchant": null,
- "initiated_by": "none",
- "api_version": "3.0",
- "reference_id": "d6a60610-3a7e-4b9d-b56f-9005b9cd18ac"
}
]
}