Skip to main content

Documentation

Simulate Clearing a Card Transaction - EEA

Simulate clearing a debit transaction.

This method triggers Webhook - Card Issuing Sale. When a fee is charged for an ATM transaction, this method also triggers Webhook - Card Issuing ATM Fee. Use this method in the sandbox

This method deducts funds from the on-hold balance in the wallet. See Wallet Balance Types.

Prerequisites:

    • amount

    • The amount of the authorization, in units of the currency defined in currency. Decimal.

    • card_id

    • ID of the card. String starting with card_.

    • category

    • Type of charge: ATM. Required when fee_amount is set.

    • currency

    • The currency supported by the card. Three-letter ISO 4217 code.

    • fee_amount

    • The amount of the fee charged for the transaction, in units of the currency defined in currency. Decimal. Required when category is set.

  • /v1/issuing/cards/clearing

  • Card Transaction Clearing - Sale

  • curl -X post
    https://sandboxapi.rapyd.net//v1/issuing/cards/clearing
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    -d '{
      "card_id": "card_c0acb5d35a78fcf4473bc98b1cda8cf9",
      "amount": 3,
      "currency": "USD",
      "authorization_id": "cardauth_d8bdc1a61f558c2f7edcbbc8b45f1586"
    }
    '
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "e1d94b6f-c8f8-4f12-827a-a9a65bb883b4"
        },
        "data": {
            "id": "cardauth_63a1b74cf0f708b6a0637bfe85e7d91f",
            "card_id": "card_c0acb5d35a78fcf4473bc98b1cda8cf9",
            "card_transaction_id": "cit_a8aaa271b7d0219ced46543b310e3678",
            "amount": 3,
            "currency_code": "USD",
            "txn_type": "SALE",
            "auth_response": {
                "code": "00",
                "message": "APPROVED_OR_COMPLETED_SUCCESSFULLY"
            },
            "is_remote_auth": false,
            "remote_auth_endpoint": "",
            "remote_auth_response": null,
            "transaction_amount": 3,
            "transaction_currency_code": "USD",
            "fx_rate": null,
            "merchant_category_code": "",
            "merchant_name_location": "TEST MERCHANT",
            "merchant_identification_code": "#RAPYD SANDBOX#"
        }
    }
  • Card Transaction Clearing - ATM

  • curl -X post
    https://sandboxapi.rapyd.net//v1/issuing/cards/clearing
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    -d '{
      "card_id": "card_c0acb5d35a78fcf4473bc98b1cda8cf9",
      "amount": 3,
      "currency": "USD",
      "authorization_id": "cardauth_4be323ac5a60c768e531a49bfd93076b",
      "category": "ATM",
      "fee_amount": 1
    }
    '
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "8a00be36-8b51-454a-bb25-28168d8f3e88"
        },
        "data": {
            "id": "cardauth_16392123dcb18a7c7df026d970d15f89",
            "card_id": "card_c0acb5d35a78fcf4473bc98b1cda8cf9",
            "card_transaction_id": "cit_2607ec2f524ed370213a6739ade3b621",
            "amount": 3,
            "currency_code": "USD",
            "txn_type": "SALE",
            "auth_response": {
                "code": "00",
                "message": "APPROVED_OR_COMPLETED_SUCCESSFULLY"
            },
            "is_remote_auth": false,
            "remote_auth_endpoint": "",
            "remote_auth_response": null,
            "transaction_amount": 3,
            "transaction_currency_code": "USD",
            "fx_rate": null,
            "merchant_category_code": "",
            "merchant_name_location": "TEST MERCHANT",
            "merchant_identification_code": "#RAPYD SANDBOX#"
        }
    }