Send Money to a Customer’s Debit Card

Start a new LinX session to send money to a Customer’s debit card. The API will perform the following operations:

Create a Customer Account for the Customer.
Create a Financial Account for the Customer’s debit card.
Create a transaction request.

Endpoint

POST /v1/linx/send

Authorization Header

Authorization: Bearer <access_token>

Request Body

debitFinancialAccountId REQUIRED

string (UUID)

ID for the Financial Account used as the debit account (source of the disbursed funds).

phoneNumber CONDITIONAL

string

format: [+][country code][phone number including area code]

Customer’s phone number. Required if email is not provided.

The phone number can be entered in one of the following formats:

[+][country code][phone number including area code] (example: +14151234)
[country code][phone number including area code] (example: 14151234)

Country code is required and must be set to 1.

email CONDITIONAL

string (email), max length: 100

Customer’s email address. Required if phoneNumber is not provided.

card REQUIRED

object

Details for the Customer’s debit card.

cardNumber REQUIRED

string, max length: 19, min length: 11, pattern: [\d]{11,19}

Card number.

cardExpiry REQUIRED

string, required format: YYYY-MM

Expiry date for the card.

customer REQUIRED

object

Customer details.

firstName REQUIRED

string, max length: 40, min length: 1

Customer’s first name.

lastName REQUIRED

string, max length: 40, min length: 1

Customer’s last name.

transaction REQUIRED

object

Transaction details.

merchantName REQUIRED

string, max length: 50

Merchant name.

merchantId REQUIRED

string, max length: 50

Reference number for the merchant.

locationId REQUIRED

string, max length: 50

Reference number for the merchant’s location.

terminalId REQUIRED

string, max length: 50

Reference number for the terminal used in the transaction.

purchaseId REQUIRED

string, max length: 50

Reference number for the purchase.

transactionType REQUIRED

string enum, value: SEND, REQUEST

Type of transaction. Possible values are:

SEND Push funds from a Financial Account to another Financial Account.
REQUEST Pull funds to a Financial Account from another Financial Account.

paymentReasonId REQUIRED

string

Unique ID representing the payment reason for the transaction. Use the Payment Reasons API to retrieve a list of available payment reasons.

amount REQUIRED

number, minimum value: 0

Amount to be disbursed to the Customer’s debit card. Must be a positive number.

message

string, max length: 200

Description of the purchase.

usePasscode

boolean, default: false

Whether a passcode will be created for the transaction. If true, a 6-digit passcode will be returned. This passcode must be provided to the customer (for example, on the customer’s receipt). The customer will be required to enter this passcode in order to access the RocketKOR Gateway site and authorize the transaction.

Returns

Returns the LinX request reference ID and the transaction status. Also returns a passcode for the transaction if usePasscode is set to true in the request. The following fields are returned.

refId

string

Reference ID for the LinX request.

status

string, values: ACTIVE, PENDING, CANCELLED, ERROR

Transaction status. Possible values are:

ACTIVE The transaction has been created in RocketKOR.
PENDING The transaction has been moved from the Transaction Domain to one of the Processing Domains. The transaction is still in the RocketKOR system and is in a state where it can be cancelled.
CANCELLED The transaction has been cancelled.
ERROR The transaction could not be processed due to one or more errors. The Error status is only activated after RocketKOR determines that it cannot continue processing the transaction.

security

object

Security details for the transaction.

passcode

string

Passcode for the transaction. Returned when usePasscode is set to true.

SAMPLE REQUEST

				
					{
  "debitFinancialAccountId": "8b4d97ec-bac3-4ce6-a4b6-b344c356f9e9",
  "phoneNumber": "+13334445566",
  "email": "john.doe@rocketbnk.com",
  "card": {
    "cardNumber": "4539984220982661",
    "cardExpiry": "2024-04"
  },
  "customer": {
    "firstName": "John",
    "lastName": "Doe"
  },
  "transaction": {
    "merchantName": "Example store",
    "merchantId": "ES123456",
    "locationId": "LOC123",
    "terminalId": "TERM1234",
    "purchaseId": "Txn12345678",
    "transactionType": "SEND",
    "paymentReasonId": "payment-of-rebates"
  },
  "amount": "50.00",
  "message": "Balance on payment at Example store",
  "usePasscode": true
}

SAMPLE RESPONSE

				
					{
  "refId": "93f1e6dd-5dc7-4660-91cc-5cb949b74c6d",
  "status": "ACTIVE",
  "security": {
    "passcode": "123456"
  }
}