Full Card API
Last updated: July 19, 2023
Before you start upgrading your Full Card API integration, make sure you've created your secret and public API keys in the Dashboard. You can then use your new API keys to submit payment requests to the same endpoint you use currently.
To upgrade your Full Card API integration to the new platform, you must include the Bearer
prefix when specifying your secret key in the authorization header. For example, Bearer sk_sbox_XXXX
.
You will need to supply a processing_channel_id
with your payment requests. This field is mandatory if your API key is assigned to multiple processing channels, but we recommend you provide it in every case. You can find the processing_channel_id
in the Developers section of the Dashboard after you create your API keys.
post
https://api.checkout.com/payments
See the following examples for a comparison of the payment requests on the current and new platforms.
1{2"source": {3"type": "card",4"number": "5199992312641465",5"expiry_month": 8,6"expiry_year": 2025,7"name": "Sarah Mitchell",8"cvv": "010"9},10"amount": 2000,11"currency": "USD",12"reference": "ORD-5023-4E89"13}
See the following examples for a comparison of the payment responses on the current and new platforms.
1{2"id": "pay_h46f2h5wzqeehcky4zoipwua2i",3"action_id": "act_h46f2h5wzqeehcky4zoipwua2i",4"amount": 2000,5"currency": "USD",6"approved": true,7"status": "Authorized",8"auth_code": "987078",9"eci": "05",10"scheme_id": "638284745624527",11"response_code": "10000",12"response_summary": "Approved",13"risk": {14"flagged": false15},16"source": {17"id": "src_4vrn6gcjndcevpdbx2bmnwgi3q",18"type": "card",19"expiry_month": 8,20"expiry_year": 2025,21"name": "Sarah Mitchell",22"scheme": "Mastercard",23"last4": "1465",24"fingerprint": "EF6107604AE20CB5EE03BE1FB3066234343D40DA23F0FCF1178C74383E55AB09",25"bin": "519999",26"card_type": "Credit",27"card_category": "Consumer",28"issuer": "BANCO COOPERATIVO DE PUERTO RICO",29"issuer_country": "PR",30"product_id": "MCS",31"product_type": "Standard MasterCard(r) Card",32"avs_check": "S",33"cvv_check": "Y"34},35"customer": {36"id": "cus_f72f3zwdkh4e7diyygph7ivsfy",37"name": "Sarah Mitchell"38},39"processed_on": "2019-01-28T15:35:09Z",40"reference": "ORD-5023-4E89",41"_links": {42"self": {43"href": "https://api.sandbox.checkout.com/payments/pay_h46f2h5wzqeehcky4zoipwua2i"44},45"actions": {46"href": "https://api.sandbox.checkout.com/payments/pay_h46f2h5wzqeehcky4zoipwua2i/actions"47},48"capture": {49"href": "https://api.sandbox.checkout.com/payments/pay_h46f2h5wzqeehcky4zoipwua2i/captures"50},51"void": {52"href": "https://api.sandbox.checkout.com/payments/pay_h46f2h5wzqeehcky4zoipwua2i/voids"53}54}55}
The Full Card API integration is automatically activated for testing in the sandbox environment. To enable this in your production environment, contact our Support team at [email protected].
See our Test cards page for a list of card numbers you can use to test card payments. To test response codes, you will now need to use test card numbers instead of requesting payments for specific amounts.