/
Retrieve associated payme...

Retrieve associated payment instruments
Experimental

Request

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

Security
SecretApiKey or JWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required

ID of the resource.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/payout-requests/{id}/payment-instruments' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Payout request associated payment instruments retrieved.

Bodyapplication/json
Array [
paymentInstrumentIdstring, <= 50 characters

ID of the payment instrument to offer for the payout.

Example:"inst_0YVB8KPKNXCBR9EDX7JHSED75N"
gatewayNamestring or null(GatewayName)

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.

Enum:"A1Gateway""ACI""Adyen""Aera""Aircash""Airpay""Airwallex""AsiaPay""AmazonPay""AmexVPC"
gatewayAccountIdstring, <= 50 characters

ID of the gateway account to use for processing this allocation.

Example:"gateway_0YVB8KPKNXCBR9EDX7JHSED75N"
gatewayPayoutInstructionstring or null

Payout configuration for the gateway account.

Enum:"all""covered-payout""approved-payment""none"null
Example:"covered-payout"
exposureAmountnumber, (double)

Approved sales and captures minus approved payouts for the specified gateway account and payment instrument in the last 180 days. Allocations on the same gateway account and payment instrument that are pending, queued, processing, or waiting-completion are also subtracted. The resulting amount is the usable exposure for ranking during auto-allocation.

previousAllocatedAmountnumber, (double)

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

lastPaymentTimestring or null, (date-time)

Date and time when the last payment is created for the gateway and the payment instrument. Payments are the result of sale or capture transactions.

lastPayoutTimestring or null, (date-time)

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

]
Response
[
  {
    "paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N",
    "gatewayName": "A1Gateway",
    "gatewayAccountId": "gateway_0YVB8KPKNXCBR9EDX7JHSED75N",
    "gatewayPayoutInstruction": "covered-payout",
    "exposureAmount": 0.1,
    "previousAllocatedAmount": 0.1,
    "lastPaymentTime": "2019-08-24T14:15:22Z",
    "lastPayoutTime": "2019-08-24T14:15:22Z"
  }
]