ID of the sticky gateway account. All future payments are processed by this gateway account. To remove the sticky gateway account from a payment instrument, set this value to null.
For more information, see Gateway routing.
Security
SecretApiKey or JWT
One of:
Example:"gw_acc_0YVCXMF26DDNKAERE5NW727S34"
Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields.
Default:{}
Example:
{ "foo": "bar" }
- Mock serverhttps://www.rebilly.com/_mock/catalog/all/payment-instruments/{id}
- Sandbox serverhttps://api-sandbox.rebilly.com/organizations/{organizationId}/payment-instruments/{id}
- Live serverhttps://api.rebilly.com/organizations/{organizationId}/payment-instruments/{id}
curl -i -X PATCH \
'https://www.rebilly.com/_mock/catalog/all/payment-instruments/{id}' \
-H 'Content-Type: application/json' \
-H 'REB-APIKEY: YOUR_API_KEY_HERE' \
-d '{
"token": "string",
"billingAddress": {
"firstName": "Benjamin",
"lastName": "Franklin",
"organization": "Rebilly",
"address": "36 Craven St",
"address2": "string",
"city": "Austin",
"region": "Texas",
"country": "GB",
"postalCode": "WC2N 5NF",
"phoneNumbers": [
{
"label": "main",
"value": "1-512-777-0269",
"primary": true
}
],
"emails": [
{
"label": "main",
"value": "rebilly@example.com",
"primary": true
}
],
"dob": "1980-04-01",
"jobTitle": "CEO"
},
"stickyGatewayAccountId": "gw_acc_0YVCXMF26DDNKAERE5NW727S34",
"customFields": {
"foo": "bar"
},
"useAsBackup": false
}'Headers
Maximum number of requests available at one time for this rate limit. For more information, see Rate limits.
Example:500
Number of requests still available for this rate limit. For more information, see Rate limits.
Example:499
Example:"inst_0YVB8KPKNXCBR9EDX7JHSED75N"
Example:"cus_0YV7DDSDD1C8DA64KHH2W33CPF"
Status of the payment instrument. An active status means that a payment instrument has been used at least once for an approved transaction. To remove an instrument from use, set this value to deactivated.
For more information, see POST /payment-instruments/{id}/deactivation.
Enum:"active""inactive""expired""deactivated""verification-needed"
Unique value that is used to identify the payment instrument. This value is generated from the bin and the last4 values. This value contains alphanumeric characters.
Bank Identification Number (BIN) of the payment card. This value is the same as the first 6 digits of the associated Primary Account Number (PAN).
Last 4 digits of the Funding Primary Account Number (FPAN) of the payment card. This value is only present for payment cards created from digital wallet tokens, where the FPAN is the physical card number visible to the cardholder, as opposed to the Device Primary Account Number (DPAN) used in the digital wallet transaction.
Enum:"Visa""MasterCard""American Express""Discover""Maestro""Solo""Electron""JCB""Voyager""Diners Club"
Specifies if payouts are supported for cards with this BIN. Defaults to true. This value is false if the BIN does not support payouts.
Default:false
Date and time of the last approved payment. Payments are the result of sale or capture transactions.
Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields.
Default:{}
Example:
{ "foo": "bar" }
ID of the sticky gateway account. All future payments are processed by this gateway account.
For more information, see Gateway routing.
Enum:"Apple Pay""Google Pay""Samsung Pay"null
Response
{ "id": "inst_0YVB8KPKNXCBR9EDX7JHSED75N", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "method": "payment-card", "status": "active", "fingerprint": "string", "bin": "string", "last4": "string", "fpanLast4": "string", "expYear": 0, "expMonth": 0, "brand": "Visa", "bankCountry": "string", "bankName": "string", "isPayoutable": true, "billingAddress": { "firstName": "Benjamin", "lastName": "Franklin", "organization": "Rebilly", "address": "36 Craven St", "address2": "string", "city": "Austin", "region": "Texas", "country": "GB", "postalCode": "WC2N 5NF", "phoneNumbers": [ … ], "emails": [ … ], "dob": "1980-04-01", "jobTitle": "CEO", "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221" }, "useAsBackup": false, "billingPortalUrl": "string", "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "lastPaymentTime": "2019-08-24T14:15:22Z", "customFields": { "foo": "bar" }, "stickyGatewayAccountId": "string", "expirationReminderTime": "2019-08-24T14:15:22Z", "expirationReminderNumber": 0, "referenceData": { "gatewayTransactionId": "GAT123" }, "digitalWallet": "Apple Pay", "riskMetadata": { "ipAddress": "93.92.91.90", "fingerprint": "pIUt3xbgX3l9g3YDiLbx", "httpHeaders": { … }, "browserData": { … }, "extraData": { … }, "isProxy": true, "isVpn": true, "isTor": true, "isHosting": true, "hostingName": "string", "isp": "string", "country": "US", "region": "NY", "city": "New York", "latitude": 0, "longitude": 0, "postalCode": "string", "timeZone": "America/New_York", "accuracyRadius": 0, "distance": 0, "hasMismatchedBillingAddressCountry": true, "hasMismatchedBankCountry": true, "hasMismatchedTimeZone": true, "hasMismatchedHolderName": true, "hasFakeName": true, "isHighRiskCountry": true, "paymentInstrumentVelocity": 0, "declinedPaymentInstrumentVelocity": 0, "deviceVelocity": 0, "ipVelocity": 0, "emailVelocity": 0, "billingAddressVelocity": 0, "paymentInstrumentApprovedTransactionCount": 0, "score": 0 }, "revision": 0, "_links": [ { … } ], "_embedded": { "customer": {} } }