v1
latestOpenAPI 3.1.02026-07-2469193340.0 KBPayment Requests
Get a Payment Request
get/payment_requests/{payment_request_ref}
Path parameters
payment_request_refstring required
Single value, exact match
Response
OK
Example response
{
"data": {
"ref": "PR.88me",
"initiator_id": "ca7bc5b3-e47f-4153-96fb-bbe326b42772",
"your_bank_account_id": "9c70871d-8e36-4c3e-8a9c-c0ee20e7c679",
"authoriser_id": "970e4526-67d9-4ed9-b554-f5cf390ab775",
"authoriser_contact_id": "de86472c-c027-4735-a6a7-234366a27fc7",
"contact_initiated": false,
"schedule_ref": null,
"status": "approved",
"status_reason": null,
"matures_at": "2021-11-25T00:00:00Z",
"responded_at": "2021-11-19T02:38:04Z",
"created_at": "2021-11-19T02:10:56Z",
"credit_ref": "C.b6tf",
"payout": {
"amount": 1200,
"description": "Xbox Live subscription",
"matures_at": "2021-11-25T00:00:00Z"
},
"metadata": {
"custom_key": "Custom string",
"another_custom_key": "Maybe a URL"
}
}
}