Interchecks

Interchecks is a growing payment service providing quick money transfers, solving the problem of delayed money settlements, leading it to become the popular choice among merchants who want to provide quick withdrawal services to their users.

The Paysafe Payments API supports Interchecks as a Payment Instrument for Cards transactions using VISA Direct as the core service.

Transaction types

Paysafe supports the following transaction types

  • Withdrawal - It is used to transfer money from the merchant account to the customer's card account, using its quick withdrawal service. To consume this service, the merchant, the user, and the card details of the user are to be provided and registered at Interchecks' end.

Typical Scenarios - Withdrawal

Case 1: New User - New Card

For a new user to consume this service, the below steps are required: This can be done in two possible ways, either the user can be registered directly or could be verified first to determine if the user exists or not, before making the registration.

  • Verification (Optional) - This can be done before Registration just to validate if the user exists already or not, in case not opting for verification and directly registration is attempted still the user will be registered as a new user and will throw an error for an existing user.

    • Create a Payment Handle request with the transactionType parameter set to VERIFICATION and the paymentType parameter set to INTERCHECKS.

    • In the interchecks object of the request packet, the consumerId should be set to the registered email ID of the user.

      • POST: paymenthub/v1/paymenthandles

    • In Response, a one-time token would be received with the tag paymentHandleToken, this token is then passed into the Verification API.

      • POST: paymenthub/v1/verifications

    • For a non-registered user, the status in the response packet will be set to FAILED and gatwayResponse.statusReason will be set to ACCOUNT_DOES_NOT_EXISTS indicating that the account is not created

  • Registration - The user can be registered by sending the profile details along with email ID, which will act as the primary identifier, to Registration API

    • Create a Registration API request with profile details and the paymentType parameter set to INTERCHECKS with interchecks object containing consumerID set to the registered email ID of the user.

      • POST: paymenthub/v1/registrations

    • The Response packet will contain the tag id which will contain an alphanumeric unique identifier for the user.

  • Add Card - Once the user is registered, the card details are also needed to be mapped to the user before the Card can be used for any transactions.

    • Create an Add Card API Request containing the card object with mandatory parameters as cardNum, cardExpiry.month and cardExpiry.year
    • The target URL in the path must contain the registration id of the user received in the response of Registration API or the response of Verification API in interchecks object with parameter name interchecks.registrationId which acts as a unique identifier for the user at Paysafe.
    • POST: paymenthub/v1/interchecks/registration/error marker error marker error marker error marker error marker {{registrationId}} on page 7981 on page 7981 on page 7981 on page 7981 on page 7981/cards
    • In Response, the card details are received back along with two additional parameters.
      • id - this acts as a uniques identifier of the card for the particular user mapped to it and could be used to delete the card if needed.

      • paymentHandleToken - This is the card token, acting as an encrypted identifier, that is used to create the withdrawal/Standalone Credit Payment Handle Token

      This paymentHandleToken received in response to Add Card API or Verification API cannot be used to create withdrawal or transaction as this token only stores the card info, to do the transaction another paymentHandleToken is required to be created which will contain the transaction details.

  • Standalone Credits - This is the final step of the transaction where the withdrawal will take place, to make this transaction initiate two important identifiers are needed about the user to be passed in the interchecks object along with transaction details.

    • Create a Payment Handle request with the transactionType parameter set to STANDALONE_CREDIT and the paymentType parameter set to INTERCHECKS.

    • In the interchecks object of the request packet, pass the consumerId should be set to the registered email ID of the user and provide the paymentHandleToken received in the response of either Add Card API or the Verification API

      • POST: paymenthub/v1/paymenthandles

    • In Response, a one-time token would be received with the tag paymentHandleToken, this token is then passed into the Standalone Credits API.

      • POST: paymenthub/v1/standalonecredits

    • The Final Response will contain the details of the transaction with parameters like id -unique identifier at Paysafe end and gatewayReconciliationId - unique identifier at Interchecks end which could be used for future references.

APIs to use: Registration+ Add Card +Payment Handle for Standalone Credits + Standalone Credits

Or

APIs to use: Payment handle for Verification + Verification + Registration + Add Card + Payment Handle for Standalone Credits + Standalone Credits

Case 2: Existing User - Existing Card

This case covers the transaction journey of a user who is already registered for Interchecks Payment method and also has at least one card saved at Interchecks end for transactions.

  • Verification - This step is mandatory for two purposes, first to determine if the user exists or not and second to get the details of already saved cards that would be used for transactions.

    • Create a Payment Handle request with the transactionType parameter set to VERIFICATION and the paymentType parameter set to INTERCHECKS.

    • In the interchecks object of the request packet, the consumerId should be set to the registered email ID of the user.

      • POST: paymenthub/v1/paymenthandles

    • In Response, a one-time token would be received with the tag paymentHandleToken, this token is then passed in the Verification API.

      • POST: paymenthub/v1/verifications

    • For a registered user, the status in the response packet will be set to COMPLETED, and interchecks object will contain the below details

      • consumerId - The unique identifier to which the user is mapped with the merchant and identified at the Interchecks end.

      • registrationId - This ID is unique to Paysafe and is used in the processes of adding cards or deleting those.

      • card - This is an array object containing details of all cards saved at the Interchecks end, each element of the array will contain two important details along with basic card details which would be used in Standalone Credits transactions and Card operations i.e. Delete.

        • id - this acts as a uniques identifier of the card for the particular user mapped to it and could be used to delete the card if needed.
        • paymentHandleToken - This is the card token, acting as an encrypted identifier, that is used to create the withdrawal/Standalone Credit Payment Handle Token

        This paymentHandleToken received in response to Add Card API or Verification API cannot be used to create withdrawal or transaction as this token only stores the card info, to do the transaction another paymentHandleToken is required to be created which will contain the transaction details

  • Standalone Credits - This is the final step of the transaction where the withdrawal will take place, to make this transaction initiate two important identifiers are needed about the user to be passed in the interchecks object along with transaction details.

    • Create a Payment Handle request with the transactionType parameter set to STANDALONE_CREDIT and the paymentType parameter set to INTERCHECKS.

    • In the interchecks object of the request packet, pass the consumerId should be set to the registered email ID of the user and provide the paymentHandleToken received in the response of either Add Card API or the Verification API

      • POST: paymenthub/v1/paymenthandles

    • In Response, a one-time token would be received with the tag paymentHandleToken, this token is then passed into the Standalone Credits API

      • POST: paymenthub/v1/standalonecredits

    • The Final Response will contain the details of the transaction with parameters like id -unique identifier at Paysafe end and gatewayReconciliationId - unique identifier at Interchecks end which could be used for future references.

APIs to use:Payment handle for Verification + Verification + Payment Handle for Standalone Credits + Standalone Credits

Case 3: Existing User - New Card

This case covers the transaction journey of a user who is already registered for the Interchecks Payment method and wants to add a new card to make the transaction: This can be done in two ways

  1. If the registrationId of the user is already available with the requestor then directly the Add Card API can be consumed followed by Payment Handle creation and Standalone Credit transaction.

  2. The Verification API could be used to get the registrationId using the email ID as consumerId in Payment Handle request.

  • Verification (Optional)- This step is mandatory for two purposes, first to determine if the user exists and second to obtain the registrationId .

    • Create a Payment Handle request with the transactionType parameter set to VERIFICATION and the paymentType parameter set to INTERCHECKS.

    • In the interchecks object of the request packet, the consumerId should be set to the registered email ID of the user.

      • POST: paymenthub/v1/paymenthandles

    • In Response, a one-time token would be received with the tag paymentHandleToken, this token is then passed into the Verification API.

      • POST: paymenthub/v1/verifications

    • For a registered user, the status in the response packet will be set to COMPLETED and interchecks object will contain the below details

      • consumerId - The unique identifier to which the user is mapped with the merchant and identified at Interchecks end.

      • registrationId - This ID is unique to Paysafe and is used in the processes of adding cards or deleting those.

    • The Response may also contain card details of already saved cards but since this case covers new card addition, hence the card details can be ignored.

  • Add Card - Once the user is registered, the card details are required to be mapped to the user before the Card can be used for any transactions.

    • Create an Add Card API Request containing the card object with mandatory parameters as cardNum, cardExpiry.month and cardExpiry.year

    • The target URL in the path must contain the registration id of the user received in the response of Registration API or the response of Verification API in interchecks object with parameter name interchecks.registrationId which acts as a unique identifier for the user at Paysafe.

      • POST: paymenthub/v1/interchecks/registration/error marker error marker error marker error marker error marker {{registrationId}} on page 7981 on page 7981 on page 7981 on page 7981 on page 7981/cards

    • In Response, the card details are received back along with two additional parameters.

      • id - this acts as a uniques identifier of the card for the particular user mapped to it and could be used to delete the card if needed.

      • paymentHandleToken - This is the card token, acting as an encrypted identifier, that is used to create the withdrawal/Standalone Credit Payment Handle Token

      This paymentHandleToken received in response to Add Card API or the Verification API cannot be used to create withdrawal or transaction as this token only stores the card info, to do the transaction another paymentHandleToken is required to be created which will contain the transaction details.

  • Standalone Credits - This is the final step of the transaction where the withdrawal will take place, to make this transaction initiate two important identifiers are needed about the user to be passed in the interchecks object along with transaction details.

    • Create a Payment Handle request with the transactionType parameter set to STANDALONE_CREDIT and the paymentType parameter set to INTERCHECKS.

    • In the interchecks object of the request packet, pass the consumerId should be set to the registered email ID of the user and provide the paymentHandleToken received in the response of either Add Card API or the Verification API

      • POST: paymenthub/v1/paymenthandles

    • In Response, a one-time token would be received with the tag paymentHandleToken, this token is then passed into the Standalone Credits API

      • POST: paymenthub/v1/standalonecredits

    • The Final Response will contain the details of the transaction with parameters like id -unique identifier at Paysafe end and gatewayReconciliationId - unique identifier at Interchecks end which could be used for future references.

APIs to use:Payment handle for Verification + Verification + Add Card + Payment Handle for Standalone Credits + Standalone Credit

Or

APIs to use:Add Card + Payment Handle for Standalone Credits + Standalone Credits

Case 4: Existing User - Delete Card

This case is to depict the steps required to delete a card that is mapped to any user, to consume the Delete API two parameters are required.

  1. registrationId of the user which is the unique identifier of the user at Paysafe end.

  2. id of the card mapped to the user, which is to be deleted, this is an unique identifier at Paysafe end.

To obtain these values Verification API is required before consuming the Delete API

  • Verification

    • Create a Payment Handle request with the transactionType parameter set to VERIFICATION and the paymentType parameter set to INTERCHECKS.

    • In the interchecks object of the request packet, the consumerId should be set to the registered email ID of the user.

      • POST: paymenthub/v1/paymenthandles

    • In Response, a one-time token would be received with the tag paymentHandleToken, this token is then passed in the Verification API.

      • POST: paymenthub/v1/verifications

    • For a registered user, the status in the response packet will be set to COMPLETED and interchecks object will contian the below details

      • consumerId - The unique identifier to which the user is mapped with the merchant and identified at Interchecks end.

      • registrationId - This ID is unique to Paysafe and is used in the processes of adding cards or deleting those.

      • card - This is an array object containing details of all cards saved at Interchecks end, each element of the array will contain two important details along with basic card details which would be used in Standalone Credits transactions and Card operations i.e. Delete.

        • id - this acts as a uniques identifier of the card for the particular user mapped to it and would be used to delete the card,

        • paymentHandleToken - This is the card token, acting as an encrypted identifier, that is used to create the withdrawal/Standalone Credit Payment Handle Token

        This paymentHandleToken received in response to Add Card API or Verification API cannot be used to create withdrawal or transaction as this token only stores the card info, to do the transaction another paymentHandleToken is required to be created which will contain the transaction details

  • Delete

    • This is a Delete call with http method set as DELETE.

    • The request will be made at the target url given below with registrationId of the user and id of the card mapped to the user.

    • Delete : /paymenthub/v1/interchecks/registration/error marker error marker error marker error marker error marker {{registrationId}} on page 7981 on page 7981 on page 7981 on page 7981 on page 7981/cards/error marker error marker {{id}} on page 7981 on page 7981

    APIs to use:Payment Handles for Verification + Verification + Delete Card

API Contracts

Registration

Registration Request example

Interchecks and profile objects are needed in the Registration request:

Interchecks and Profile Object

"profile": {
    "firstName": "Sandi",
   "lastName":"Smith"
  },
"interchecks": {
    "consumerId": ""sandi.smith@email.com"
  }

Parameter Type Mandatory Description
interchecks.consumerId String True

Customer/end-user email id which will be the unique identifier of the user at Interchecks end

profile.firstName String True

First Name of the user to be registered.

profile.lastName String True

Last Name of the user to be registered.

Registration Request Example

{
  "merchantRefNum": "592ce14-67c5-406e-8c35-0e32063e2a44",
  "paymentType": "INTERCHECKS",
  "profile": {
     "firstName": "Sandi",
     "lastName":"Smith"
  },
  "accountId": "1098762309",
  "billingDetails": {
    "nickName": "Home",
    "street": "20735 Stevens Creek Blvd",
    "street2": "Montessori",
    "city": "Cupertino",
    "country": "US",
    "state": "CA",
    "zip": "95014"
  },
  "interchecks": {
    "consumerId": "sandi.smith@email.com"
  }
}

Registration Response Example

Parameter Type Mandatory Description
interchecks.consumerId String True

Customer/end-user email id which will be the unique identifier of the user at Interchecks end

profile.firstName String True

First Name of the user to be registered.

profile.lastName String True

Last Name of the user to be registered.

gatewayResponse.firstName String True

First Name of the user sent and stored at Interchecks as provided in the request.

gatewayResponse.lastName String True

Last Name of the user sent and stored at Interchecks as provided in the request.

gatewayResponse.id String True

Registration ID of the user account created, acting as the unique identifier for Paysafe.

gatewayResponse.processor String True

Payment processor at which the operations are taking place.

Registration Response Example

{
    "id": "bfb62099-5de2-401f-90d8-40cf5f2d2320",
    "paymentType": "INTERCHECKS",
    "merchantRefNum": "d8659308-5092-48fa-8030-76c5997dace3",
    "billingDetails": {
        "street": "20735 Stevens Creek Blvd",
        "street2": "Montessori",
        "city": "Cupertino",
        "zip": "95014",
        "state": "CA",
        "country": "US"
    },
    "status": "COMPLETED",
    "liveMode": true,
    "transactionDate": "2022-03-24T10:03:51.000Z",
    "gatewayResponse": {
        "firstName": "Kumar",
        "lastName": "Priyanshu",
        "id": "3595b9a7-0255-4770-aa9a-b816e353f05b",
        "processor": "INTERCHECKS"
    },
    "interchecks": {
        "consumerId": "priyanshu@email.com"
    },
    "profile": {
        "firstName": "Kumar",
        "lastName": "Priyanshu"
    }
}

To know more about each parameter, you can visit Registration API

Verification

Parameter Type Mandatory Description
interchecks.consumerId String True

Customer/end-user email id which will be the unique identifier of the user at Interchecks end

Verification PH Response Example

{
    "merchantRefNum": "{{$guid}}",
    "transactionType": "VERIFICATION",
    "amount": 1000,
    "interchecks": {
        "consumerId": "priyanshu@email.com"
    },
    "paymentType": "INTERCHECKS",
    "currencyCode": "USD",
    "accountId": "1098762309",
    "customerIp": "172.0.0.1",
    "billingDetails": {
        "nickName": "Home",
        "street": "street",
        "city": "ca",
        "state": "CA",
        "country": "US",
        "zip": "50087"
    },
    "profile": {
        "firstName": "Kumar",
        "lastName": "Priyanshu"
        },
    "merchantDescriptor": {
        "dynamicDescriptor": "OnlineStoreeeeeeeee",
        "phone": "1234567899"
    }
}

Verification PH Response Example

Parameter Type Description
paymentHandleToken String

This is a single-use verification token that stores the details of the user, requested for verification

Verification PH Response Example

{
    "id": "400c337d-3175-4515-aff4-961e86b9255c",
    "paymentType": "INTERCHECKS",
    "paymentHandleToken": "PHkJzMFEjxBQxjOK",
    "merchantRefNum": "0d4c3727-b79e-4581-9855-6a1444b98811",
    "currencyCode": "USD",
    "txnTime": "2022-03-25T07:49:42Z",
    "billingDetails": {
        "street": "street",
        "city": "ca",
        "zip": "50087",
        "state": "CA",
        "country": "US"
    },
    "customerIp": "172.0.0.1",
    "status": "PAYABLE",
    "liveMode": false,
    "action": "NONE",
    "executionMode": "SYNCHRONOUS",
    "amount": 1000,
    "merchantDescriptor": {
        "dynamicDescriptor": "OnlineStoreeeeeeeee",
        "phone": "1234567899"
    },
    "timeToLiveSeconds": 899,
    "transactionType": "VERIFICATION",
    "updatedTime": "2022-03-25T07:49:42Z",
    "statusTime": "2022-03-25T07:49:42Z",
    "interchecks": {
        "consumerId": "priyanshu@email.com"
    },
    "singleUsePaymentHandle": false,
    "profile": {
        "firstName": "Kumar",
        "lastName": "Priyanshu"
    }
}

To know more about each parameter, you can visit Payment Handles

Verification API Request Example

Parameter Type Mandatory Description
paymentHandleToken String True

This is a single-use verification token that stores the details of the user, requested for verification

Verification API Request Example

{
  "paymentHandleToken": "PHkJzMFEjxBQxjOK",
  "merchantRefNum": "{{$guid}}",
  "currencyCode": "USD",
  "customerIp": "172.10.12.64"
}

Verification API Response Example

Parameter Type Description
interchecks.consumerId String

This is a single-use verification token that stores the details of the user, requested for verification

interchecks.profile.firstName String

First Name of the user sent and stored at Interchecks as provided in the request.

interchecks.profile.lastName String

Last Name of the user sent and stored at Interchecks as provided in the request.

interchecks.registrationId String

Registration ID of the user account created, acting as the unique identifier for Paysafe.

interchecks.card.id String

ID of the user card account created, acting as the unique identifier for Paysafe.

interchecks.card.paymentHandleToken String

Unique card token, which stores the information of card and user and is passed in the request of Payment Handle creation for Standalone/Withdrawal transaction type.

Verification API Response Example

{
    "id": "1e997c4b-26c6-400a-ace4-259a266177df",
    "paymentType": "INTERCHECKS",
    "paymentHandleToken": "PHkJzMFEjxBQxjOK",
    "merchantRefNum": "28084669-6b76-4060-aaed-f133e1ec6304",
    "currencyCode": "USD",
    "txnTime": "2022-03-25T07:53:39Z",
    "billingDetails": {
        "street1": "street",
        "city": "ca",
        "zip": "50087",
        "state": "CA",
        "country": "US"
    },
    "status": "COMPLETED",
    "updatedTime": "2022-03-25T07:53:40Z",
    "statusTime": "2022-03-25T07:53:40Z",
    "liveMode": false,
    "gatewayResponse": {
        "processor": "INTERCHECKS"
    },
    "interchecks": {
        "consumerId": "priyanshu@email.com",
        "registrationId": "bfb62099-5de2-401f-90d8-40cf5f2d2320",
        "card": [
            {
                "id": "4d97455e-1651-402f-85fa-23a15847a68e",
                "bankName": "840",
                "cardExpiry": {
                    "month": "10",
                    "year": "2028"
                },
                "lastDigits": "2169",
                "cardBin": "531260",
                "usage": "MULTI_USE",
                "paymentHandleToken": "ICfgXyirA4FsaG89",
                "cardCategory": "DEBIT"
            },
            {
                "id": "8bc88300-9e0a-44bb-8c13-d365ef2b3bdb",
                "bankName": "840",
                "cardExpiry": {
                    "month": "10",
                    "year": "2028"
                },
                "lastDigits": "2169",
                "cardBin": "531260",
                "usage": "MULTI_USE",
                "paymentHandleToken": "IC7efaRaUFalbM0L",
                "cardCategory": "DEBIT"
            }
        ]
    },
    "profile": {
        "firstName": "Kumar",
        "lastName": "Priyanshu"
    }
}

To know more about each parameter, you can visit Verification API

Standalone Credit / Withdrawal

Standalone Credit Request PH Example

Parameter Type Mandatory Description
transactiontype String True

"STANDALONE_CREDIT" for the withdrawal transaction.

interchecks.consumerId String True

Customer/end-user email id which is the unique identifier of the user at Interchecks end.

interchecks.card.paymentHandleToken String True

Unique card token, which stores the information of card and user and is passed in the request of Payment Handle creation for Standalone/Withdrawal transaction type, received either in response of Verification API or Add Card API.

SCT PH Request Example

{
    "merchantRefNum": "{{$guid}}",
    "transactionType": "STANDALONE_CREDIT",
    "amount": 1000,
    "interchecks": {
        "consumerId": "priyanshu@email.com",
        "paymentHandleToken": "IC7efaRaUFalbM0L"
    },
    "paymentType": "INTERCHECKS",
    "currencyCode": "USD",
    "accountId": "1098762309",
    "customerIp": "172.0.0.1",
    "billingDetails": {
        "nickName": "Home",
        "street": "street",
        "city": "ca",
        "state": "CA",
        "country": "US",
        "zip": "50087"
    },

    "merchantDescriptor": {
        "dynamicDescriptor": "OnlineStoreeeeeeeee",
        "phone": "1234567899"
    }
}

Standalone Credit PH Response Example

Parameter Type Description
paymentHandleToken String

This is a single-use verification token that stores the details of the user, card, amount, and transaction, requested for Standalone Credit Transaction.

SCT PH Response Example

{
    "id": "f7dd2417-d563-4dcb-9cda-4d776ed9fe22",
    "paymentType": "INTERCHECKS",
    "paymentHandleToken": "PHIueNW2rVPxEKsr",
    "merchantRefNum": "02eaaf86-9fae-4229-8455-5ec384ee2a07",
    "currencyCode": "USD",
    "txnTime": "2022-03-25T08:10:28Z",
    "billingDetails": {
        "street": "street",
        "city": "ca",
        "zip": "50087",
        "state": "CA",
        "country": "US"
    },
    "customerIp": "172.0.0.1",
    "status": "PAYABLE",
    "liveMode": false,
    "action": "NONE",
    "executionMode": "SYNCHRONOUS",
    "amount": 1000,
    "merchantDescriptor": {
        "dynamicDescriptor": "OnlineStoreeeeeeeee",
        "phone": "1234567899"
    },
    "timeToLiveSeconds": 899,
    "transactionType": "STANDALONE_CREDIT",
    "updatedTime": "2022-03-25T08:10:29Z",
    "statusTime": "2022-03-25T08:10:29Z",
    "singleUsePaymentHandle": false,
    "interchecks": {
        "consumerId": "priyanshu@email.com",
        "registrationId": "bfb62099-5de2-401f-90d8-40cf5f2d2320",
        "paymentHandleToken": "IC7efaRaUFalbM0L"
    }
}

Standalone Credit Request Example

Parameter Type Description
paymentHandleToken String

This is a single-use verification token that stores the details of the user, card, amount, and transaction, requested for Standalone Credit Transaction.

SCT Request Example

curl -X POST https://api.test.paysafe.com/paymenthub/v1/standalonecredits \
  -u devcentre322:B-qa2-0-53625f86-302c021476f52bdc9deab7aea876bb28762e62f92fc6712d0214736abf501e9675e55940e83ef77f5c304edc7968 \
  -H 'Content-Type: application/json' \
  -d ' {
    "merchantRefNum": "10f64573-65d8-4d14-8337-66264094662f",
    "amount": 1407,
    "currencyCode": "USD",
    "paymentHandleToken": "SC7nzOK9blfEKX1r",
    "description": "Demo Paysafe Js"
} '
curl -X POST https://api.test.paysafe.com/paymenthub/v1/standalonecredits \
  -u devcentre322:B-qa2-0-53625f86-302c021476f52bdc9deab7aea876bb28762e62f92fc6712d0214736abf501e9675e55940e83ef77f5c304edc7968 \
  -H 'Content-Type: application/json' \
  -d ' {
    "merchantRefNum": "10f64573-65d8-4d14-8337-66264094662f",
    "amount": 1407,
    "currencyCode": "USD",
    "paymentHandleToken": "SC7nzOK9blfEKX1r",
    "description": "Demo Paysafe Js"
} '

Standalone Credit Response Example

Parameter Type Description
gatewayReconciliationId String

Unique identifier for the transaction at Interchecks end which could be used for future references.

SCT Response Example

{
  "id": "e075f2ae-dfc4-4f6d-8d89-61158367b6a6",
  "amount": 1407,
  "merchantRefNum": "10f64573-65d8-4d14-8337-66264094662f",
  "paymentHandleToken": "SC7nzOK9blfEKX1r",
  "customerIp": "204.91.0.12",
  "currencyCode": "USD",
  "paymentType": "CARD",
  "status": "PENDING",
  "description": "Demo Paysafe Js""
}

To know more aout each parameter, you can visit Standalone Credits

Add Card and Delete Card, Add Card Request sample

URL: Post: paymenthub/v1/interchecks/registration/error marker error marker error marker error marker error marker {{registrationId}} on page 7981 on page 7981 on page 7981 on page 7981 on page 7981/cards

Parameter Type Mandatory Description
cardNum String True

Card Number to be added to the user.

cardExpiry.month String True

The month of the expiry of the card.

cardExpiry.year String True

The year of the expiry of the card.

holderName String False

Card Holder Name.

registrationId String True

Registration ID of the user to whom the card has to be mapped to be provided in the target URL.

SCT PH Request Example

{
    "cardNum": "5312600000002169",
    "cardExpiry": {
        "month": 10,
        "year": 2028
    },
    "holderName": "Kumar"
}

Add Card Response sample

Parameter Type Description
id String

ID of the user card account created, acting as the unique identifier for Paysafe.

paymentHandleToken String

Unique card token, which stores the information of card and user and is passed in the request of Payment Handle creation for Standalone/Withdrawal transaction type.

SCT PH Response Example

{
    "id": "3b877c2e-7c55-4cf2-bae5-537640505011",
    "bankName": "840",
    "holderName": "Kumar",
    "cardBin": "531260",
    "lastDigits": "2169",
    "cardCategory": "DEBIT",
    "usage": "MULTI_USE",
    "cardExpiry": {
        "month": 10,
        "year": 2028
    },
    "paymentHandleToken": "ICEc10EKv4xaK8dC"
}

Delete Card Request Sample

URL: Delete : /paymenthub/v1/interchecks/registration/error marker error marker error marker error marker error marker {{registrationId}} on page 7981 on page 7981 on page 7981 on page 7981 on page 7981/cards/error marker error marker {{id}} on page 7981 on page 7981

Parameter Type Description
id String

ID of the user card account created, acting as the unique identifier for Paysafe.

registrationId String

ID of the user card account created, acting as the unique identifier for Paysafe.

Appendix

Webhooks

  1. PAYMENT_HANDLE_PAYABLE - This webhook signifies that the Payment Handle token created for the required purpose can now be executed and the preliminary requirements are completed, the next API call with the payment handle can be done.

  2. PAYMENT_HANDLE_COMPLETED - This webhook is triggered when the process of the payment handle is token is completed after triggering the next API i.e. Verification or Standalone Credit API.

  3. PAYMENT_HANDLE_EXPIRED - This webhook is triggered when the next step is not initiated after the payment handle is created within the given time frame, the duration can be seen in response of /paymenthub/v1/paymenthandles API under the tag timeToLiveSeconds.

  4. SA_CREDIT_FAILED - This webhook is triggered in case the transaction was initially completed and later failed due to some settlement error.

  5. SA_CREDIT_CANCELLED - This webhook is triggered when the transaction was canceled after it was completed

  6. SA_CREDIT_RETURN_COMPLETED - This webhook is a subsequent update that is sent to the merchant when an automated API is triggered in cases when the Standalone Credit is failed post-completion and the user's account at merchant end should be updated with the credit amount as the transaction couldn't complete through.

Did you find this page useful?