Credit

Credits are payment refunds issued by a merchant to a cardholder after the cardholder paid for a product or service, which is then processed by the merchant. Upon approval of a credit request, the issuer moves funds from the merchant bank (acquirer) account to the customer's account. The standard timeframe for the acquirer to transfer funds from the merchant account is typically 2 to 4 days.

Credit
POST /v1/payments/credits

curl –X POST 'https://api.firstoken.co/v1/payments/credits' \
--header 'Content-Type: application/json' \
--header 'x-api-key: YOUR API KEY' \
--data-raw '{
    "transaction_info": {
        "type": "credit",
        "reference_code": "123456789"
    },
    "card":{
        "number": "4111111111111111"
        "expiration_date": "01/2024"
    },
    "order_info": {
        "amount_details": {
            "total_amount": 1000,
            "currency": "COP"
        }
    },
    "bill_to": {
        "first_name": "John",
        "last_name": "Doe",
        "country": "US",
        "address_1": "1 Market St",
        "address_2": "Suite 200",
        "city": "san francisco",
        "state": "CA",
        "phone_number": "4158880000",
        "email": "test@cybs.com",
        "postal_code": "94105"
    },
    "device_info": {
        "ip_address": "12.7.8.120"
    }
}'
Credit with permanent token
POST /v1/payments/credits

curl –X POST 'https://api.firstoken.co/v1/payments/credits' \
--header 'Content-Type: application/json' \
--header 'x-api-key: YOUR API KEY' \
--data-raw '{
    "transaction_info": {
        "type": "credit",
        "reference_code": "123456789"
    },
    "card": {
        "number": "{{ 0beb9110-45d6-4df1-9d61-6b8081cd83b2 : detokenize }}",
        "expiration_date": "{{ 0beb9110-45d6-4df1-9d61-6b8081cd83b2 : detokenize }}"
    },
    "order_info": {
        "amount_details": {
            "total_amount": 1000,
            "currency": "COP"
        }
    },
    "bill_to": {
        "first_name": "John",
        "last_name": "Doe",
        "country": "US",
        "address_1": "1 Market St",
        "address_2": "Suite 200",
        "city": "san francisco",
        "state": "CA",
        "phone_number": "4158880000",
        "email": "test@cybs.com",
        "postal_code": "94105"
    },
    "device_info": {
        "ip_address": "12.7.8.120"
    }
}'
Credit with temporal token
POST /v1/payments/credits

curl –X POST 'https://api.firstoken.co/v1/payments/credits' \
--header 'Content-Type: application/json' \
--header 'x-api-key: YOUR API KEY' \
--data-raw '{
    "transaction_info": {
        "type": "credit",
        "reference_code": "123456789"
    },
    "card": {
        "number": "{{ fa5f200d-2c48-41a5-a4c8-b4ec27819868 : transaction }}",
        "expiration_date": "{{ fa5f200d-2c48-41a5-a4c8-b4ec27819868 : transaction }}"
    },
    "order_info": {
        "amount_details": {
            "total_amount": 1000,
            "currency": "COP"
        }
    },
    "bill_to": {
        "first_name": "John",
        "last_name": "Doe",
        "country": "US",
        "address_1": "1 Market St",
        "address_2": "Suite 200",
        "city": "san francisco",
        "state": "CA",
        "phone_number": "4158880000",
        "email": "test@cybs.com",
        "postal_code": "94105"
    },
    "device_info": {
        "ip_address": "12.7.8.120"
    }
}'
Credit with both tokens
POST /v1/payments/credits

curl –X POST 'https://api.firstoken.co/v1/payments/credits' \
--header 'Content-Type: application/json' \
--header 'x-api-key: YOUR API KEY' \
--data-raw '{
    "transaction_info": {
        "type": "payment",
        "reference_code": "123456789"
    },
    "card": {
        "number": "{{ 0beb9110-45d6-4df1-9d61-6b8081cd83b2 : detokenize }}",
        "expiration_date": "{{ 0beb9110-45d6-4df1-9d61-6b8081cd83b2 : detokenize }}",
        "security_code": "{{ fa5f200d-2c48-41a5-a4c8-b4ec27819868 : transaction }}"
    },
    "order_info": {
        "amount_details": {
            "total_amount": 1000,
            "currency": "COP"
        }
    },
    "bill_to": {
        "first_name": "John",
        "last_name": "Doe",
        "country": "US",
        "address_1": "1 Market St",
        "address_2": "Suite 200",
        "city": "san francisco",
        "state": "CA",
        "phone_number": "4158880000",
        "email": "test@cybs.com",
        "postal_code": "94105"
    },
    "device_info": {
        "ip_address": "12.7.8.120"
    }
}'

With these endpoint we can get the following response

{
    "status": "success",
    "message": "Credit successful",
    "data": {
        "transaction_info": {
            "type": "credit_response",
            "reference_code": "123456789",
            "transaction_id": "0001709064963668730958",
            "request_id": "7090649650186344904953",
            "status": "Pending",
            "reconciliation_id": "7090649650186344904953",
            "created_at": "2024-02-27T20:16:05Z"
        },
        "order_info": {
            "amount_details": {
                "credit_amount": 1000,
                "currency": "COP"
            }
        }
    }
}
PreviousRefunds voidNextCredit Void

Last updated

Was this helpful?