Instruments
Get instrument details
Retrieve the details of a payment instrument.
get/instruments/{id}
Request
- Base URLhttps://{prefix}.api.sandbox.checkout.com
- Auth
- OAuth 2Client credentialsToken URLstringScopesvault, vault:instruments
- or API key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring required
The instrument ID
Response
Instrument retrieved successfully
Example response
{
"id": "src_wmlfc3zyhqzehihu7giusaaawu",
"fingerprint": "vnsdrvikkvre3dtrjjvlm5du4q",
"account_type": "savings",
"account_number": "13654567455",
"bank_code": "123-456",
"branch_code": "6443",
"iban": "HU93116000060000000012345676",
"bban": "3704 0044 0532 0130 00",
"swift_bic": "37040044",
"currency": "GBP",
"country": "GB",
"account_holder": {
"type": "individual",
"first_name": "John",
"last_name": "Smith",
"tax_id": "123456",
"date_of_birth": "1986-01-01T00:00:00.0000000",
"country_of_birth": "GB",
"residential_status": "resident",
"billing_address": {
"address_line1": "123 High St.",
"address_line2": "Flat 456",
"city": "London",
"zip": "SW1A 1AA",
"country": "GB"
},
"phone": {
"country_code": "+1",
"number": "415 555 2671"
},
"identification": {
"type": "SSN"
}
},
"bank": {
"name": "Lloyds TSB",
"branch": "Bournemouth",
"address": {
"address_line1": "123 High St.",
"address_line2": "Flat 456",
"city": "London",
"zip": "SW1A 1AA",
"country": "GB"
}
},
"customer": {
"id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
"email": "brucewayne@gmail.com",
"name": "Bruce Wayne",
"default": true,
"metadata": {
"coupon_code": "SPRING"
}
},
"metadata": {
"documentNumber": "12345678900",
"partnerId": "partner_123"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.