Skip to content

Get payment instruments

Request

Security
oauth2(Required scopes: payment.instrument:list) or bearerAuth or apiKeyHeader
Path
personIdstring(AnyId)^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+$write-onlyrequired

A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.

Query
isExternalboolean

Fetch entities that are marked external.

includeDeletedboolean

Include entities that are marked deleted.

Default:false
showFullAccountNumberboolean

Provide raw untokenized account details: cardNumber for cards, accountNumber for bank accounts, checks, wires, and money orders.

Requires the payment.instrument:read.sensitive permission.

Default:false
GET
/people/{personId}/payment-instruments
curl -i -X GET \
  'https://sandboxapi.peach.finance/api/people/{personId}/payment-instruments?isExternal=true&includeDeleted=false&showFullAccountNumber=false' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Payment Instruments

Bodyapplication/json
countinteger, (int32)read-onlyrequired

Total number of items in this result.

statusinteger

HTTP status code.

dataArray of any(PaymentInstrumentGet)required
Response
{
  "count": 0,
  "status": 0,
  "data": [
    { … }
  ]
}