/
Create a payment instrume...

Create a payment instrument

Request

Creates a payment instrument.

To use this operation, you must first create a payment token using FramePay, then provide the token ID in this operation.

Security
CustomerJWT or PublishableApiKey
Bodyapplication/jsonrequired

Payment instrument.

tokenstringrequired

Token ID of the payment instrument.

customFieldsobject(ResourceCustomFields)

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"
}
curl -i -X POST \
  https://www.rebilly.com/_mock/catalog/all/storefront/payment-instruments \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "token": "string",
    "customFields": {
      "foo": "bar"
    }
  }'

Responses

Payment instrument created.

Headers
Locationstring, (uri)

Location of the related resource.

Example:"https://api.rebilly.com/example"
X-RateLimit-Limitinteger

Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.

Example:3600
X-RateLimit-Remaininginteger

Remaining number of rate limit tokens for this request within the rate limit period. For example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.

Example:3600
Bodyapplication/json
One of:

Payment card information.

idstring, <= 50 characters(ResourceId)read-only

ID of the payment instrument.

Example:"4f6cf35x-2c4y-483z-a0a9-158621f77a21"
methodstringread-only

Method of payment instrument.

Value:"payment-card"
statusstring

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 Deactivate a payment instrument.

Enum:"active""inactive""expired""deactivated""verification-needed"
fingerprintstringread-only

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.

binstring, (bin)read-only

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).

last4stringread-only

Last 4 digits of the associated Primary Account Number (PAN).

expYearinteger

Expiration year of the payment card.

expMonthinteger

Expiration month of the payment card.

digitalWalletstring or nullread-only

Digital wallet type.

Enum:"Apple Pay""Google Pay""Samsung Pay"null
brandstring(PaymentCardBrand)read-only

Brand of payment card.

Enum:"Visa""MasterCard""American Express""Discover""Maestro""Solo""Electron""JCB""Voyager""Diners Club"
bankCountrystringread-only

Bank country of the payment instrument.

bankNamestringread-only

Bank name of the payment instrument.

isPayoutablebooleanread-only

Specifies if payouts are supported for cards with this BIN. Defaults to true. This value is false if the BIN does not support payouts.

billingAddressobject(ContactObject)

Contact's billing address.

useAsBackupboolean(UseAsBackup)

Specifies if this payment instrument can be used as a backup for invoice payment retries.

Default:false
billingPortalUrlstringread-only

URL of the billing portal where the card can be updated.

createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

lastPaymentTimestring or null, (date-time)(LastPaymentTime)read-only

Date and time of the last approved payment. Payments are the result of sale or capture transactions.

customFieldsobject(ResourceCustomFields)

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"
}
tokenstring or nullread-only

New customer JSON Web Token (JWT) that is used for further requests. This value is null if the customer is already authenticated.

Response
{
  "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  "method": "payment-card",
  "status": "active",
  "fingerprint": "string",
  "bin": "string",
  "last4": "string",
  "expYear": 0,
  "expMonth": 0,
  "digitalWallet": "Apple Pay",
  "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"
  },
  "token": "string",
  "_links": [
    { … }
  ]
}