Originate a pull transaction
In this tutorial, you'll learn how to:
✅ Register the relevant webhooks
✅ Sign up a card
✅ Start a pull transaction
This tutorial assumes you have a knowledge of APIs and how they work. Refer to the API overview page for more details.
An Account Funding Transaction (AFT) lets you pull funds from a debit card for specific purposes. You can use an AFT to fund a wallet or a prepaid card. Or, you can use it to initiate a person to person (P2P) transfer through the card network rails. AFTs are not allowed for buying goods and services.
The tutorial uses these API endpoints:
API | Description |
|---|---|
Signs up a card | |
Starts a pull payment |
The tutorial uses these webhooks:
Webhook | Description |
|---|---|
CardAuthorized |
|
Transaction | Reports a transaction |
Make sure you have:
- requestId - your unique reference ID
- cardToken - the token you received when you signed up the card
- The dollar amount to send
Use this endpoint, POST /api/WebhookRegistrations, to sign up to receive the webhooks available for P2C. These webhooks report relevant events back to your system in real-time. This keeps you up to date on each transaction.
To start a transaction you must first register a card. We use different endpoints to be able to secure your customer's debit card numbers. To register a card, send Cross River the card number. The card number is instantly converted into a token. Cross River doesn't save any card number information. Doing this asynchronously allows Cross River to store your customer's card information. This ensures that you don't need to retrieve the card information again. It also keeps your customer's data secure.
- When a card is registered, Cross River validates the card with the relevant card network. This makes sure the card is a valid card and that it is allowed to receive payments.
- The CardAuthorized webhook is triggered.
When you start a transfer, you are requesting funds (as the recipient) from a payor.
- Authenticate into the Cross River system. This returns a token to you.
- Use the token to call POST /api/PullTransaction.
- Cross River sends this request to the card networks. The networks route the transaction to the appropriate bank.
- The issuing bank (of the registered debit card) receives the transaction.
- The issuing bank either authorizes or declines the transaction.
- If the transaction is authorized, Cross River responds to your API call as shown below.
