Developer docs
/
Rebilly API
/
Transactions
/
Retrieve associated payment instruments

Retrieve associated payment instruments

Retrieves the payment gateway and a list of payment instruments that are associated with a payout request with a specified ID.

SecurityAPI Key: SecretApiKey or HTTP: JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

get
/payout-requests/{id}/payment-instruments
Responses

200

Payout request associated payment instruments retrieved.

Response Schema: application/json
Array
paymentInstrumentId
string <= 50 characters

ID of the payment instrument to offer for the payout.

gatewayName
string or null

Name of the payment gateway and payment instrument to use for the payout. This field is empty if the requested payment instrument has not been used yet.

exposureAmount
number <double>

Total amount of sales minus credit for the specified gateway and instrument.

previousAllocatedAmount
number <double>

Total amount of allocated credit for the payout request for the specified gateway and instrument.

lastPaymentTime
string <date-time>

Date and time when the last payment is created for the gateway and the payment instrument.

lastPayoutTime
string <date-time>

Date and time when the last payout is created for the gateway and the payment instrument.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

Response samples
application/json
[
{
"paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N",
"gatewayName": "A1Gateway",
"exposureAmount": 0.1,
"previousAllocatedAmount": 0.1,
"lastPaymentTime": "2019-08-24T14:15:22Z",
"lastPayoutTime": "2019-08-24T14:15:22Z"
}
]