Request funds from a payor
POST /api/PullTransaction
Use this call to pull funds from a payor.
When you POST a pull or push transaction, send the cardToken
, amount
, and RequestId
in the request body JSON.
When P2C receives the POST request, it uses the token to retrieve the debit card number and performs the transaction. The API response includes the card token, amount transferred, and a transaction status which indicates success/failure.
Request attributes
Attribute | Description |
---|---|
requesterId GUID | Merchant ID. Optional |
requesterName string | Merchant name. Optional |
requesterMcc string | Merchant Category Code (MCC). 4-digits that a credit card issuer uses to categorize consumer transactions for their card. Optional |
CVV string | The card verification value. Optional |
requestId GUID | Unique customer generated transaction ID. This parameter corresponds to the TransacationRequestId in the response.Required |
cardToken string | Card token for the signed-up debit card. Required |
amount integer | Transaction amount in cents. Required |
Sample request POST /api/PullTransaction
{
"requesterId": "298fa967-97dp-vvy6-afag-11sghvk6nx12",
"requesterName": "Cooks",
"requesterMcc": "5134",
"cvv": "300",
"requestId": "20V5A0DC-B53B-4AB5-A7C9-6E9BE63D7303",
"cardToken": "<card token>",
"amount": 250
}
Response attributes
Attribute | Description |
---|---|
transactionRequestId GUID | This parameter corresponds to the RequestId in the response. |
amount integer | Transaction amount in cents. |
transactionRequestedAt string | Date and time the transaction was requested. |
transactionStatus string | Status of the transaction: - Succeeded - Pending - Failed - Rejected |
errorDescription string | Description of any error that might have occurred. |
creditCardId string | Card token of the signed-up debit card. |
railId string | The processor used to perform the transaction. - RS2 - McSend - TabaPay |
network string | Card network. - Visa - Mastercard - ET - PULSE - STAR - NYCE - Accel - RPPS - MoneySend |
retrievalReferenceId GUID | Unique tracking identifier for this transaction in the processors to correlate this transaction to the processors. |
actualTransactionDoneAt string | Actual time the transaction was sent to the processor. |
requestApproved boolean | True if the payment passed all the way to the processor successfully, otherwise false. |
responseReceived boolean | True if P2C received a response from the external processor, otherwise false. |
responseCode string | An ISO 8583 two-digit code signifying the transaction result. For example, 00 means successful. |
responseDescription string | An ISO 8583 string description of the transaction result. For example, Approved. |
traceNumber string | Unique number that is assigned to a transaction when it leaves the merchant bank until it arrives at the cardholder bank. |
error string | Descriptive error, if relevant. |
requesterName string | Name of the requester of the payment. |
requesterMcc string | Merchant Category Code (MCC). 4-digits that a credit card issuer uses to categorize consumer transactions for their card. |
IsSuccessfull boolean | True if the transaction is successful, otherwise false. |
Sample response POST /api/PullTransaction
{
"result": {
"transactionRequestId": "IAB3D1FA-51F1-4B3D-GAE8-46HHSFVVH980",
"amount": 400,
"transactionRequestedAt": "2022-08-03T21:09:13.5882004Z",
"transactionStatus": "Succeeded",
"errorDescription": "null",
"creditCardId": "<CARD TOKEN>",
"railId": "TabaPay",
"network": "MasterCard",
"retrievalReferenceId": "8ABDQ2GA-51C1-4N23-9HJ8-69VKL77DNCC0",
"actualTransactionDoneAt": "2022-08-03T21:09:13.937108Z",
"requestApproved": true,
"responseReceived": true,
"responseCode": "00",
"responseDescription": "Approved",
"traceNumber": "8ABJLKY1-G1CC-3DN3-H841-6BOPD73FLP6540",
"error": "null",
"requesterName": "null",
"requesterMcc": "null"
},
"isSuccessful": true,
}
Updated 7 months ago