ARC Pay API v70

Number of APIs: 31

About ARC Pay API

Integration Guidelines

This collection demonstrates the capabilities of the ARC Pay API REST APIs

• Gateway
• Session
• Initiate Checkout
• Payment
• Tokenization
• Order
• Refund
• Initiate Authentication
• Payer Authentication

Getting Started

Create the following environment:

• PROD

Select the target environment (PROD)

Set the following environment variables for the target environment:

Important

You must provide a unique order reference for each order. This ensures your orders can easily be identified in the merchant portal as well as be traced through ARC's settlement system.

Recommended order reference generation strategies:

• nanoid https://github.com/ai/nanoid#readme

import { nanoid } from 'nanoid'
order.reference = nanoid(15) // "xMVqs6PwuNmy4DL"

• timestamp

order.reference = Math.floor(Math.random() * Date.now()).toString() //"1310759939123"

• uuid https://github.com/uuidjs/uuid

import { v4 as uuidv4 } from 'uuid';
order.reference = uuidv4(); // "43de18f3-596d-4e9f-96e5-d62c2c86b03d"

Note: this collection uses Qodex's dyanamic variable $guid to generate both order.id and order.reference. $guid is a uuid-v4 style uuid. [

Additionally, airline.ticket.issue.travelAgentCode and airline.ticket.issue.travelAgentName must be submitted with each transaction. https://api.arcpay.travel/api/documentation/integrationGuidelines/supportedFeatures/pickAdditionalFunctionality/supplementaryData.html?locale=enUS#xairline

1. Hosted Checkout - Checkout mode: Payment Link POST https://{{domain}}/api/rest/version/{{collectionVersion}}/merchant/{{merchantId}}/session

2. Tokenization - Operation 7: Create Token POST https://{{domain}}/api/rest/version/{{collectionVersion}}/merchant/{{merchantId}}/token

3. Tokenization - Operation 1: Create Session POST https://{{domain}}/api/rest/version/{{collectionVersion}}/merchant/{{merchantId}}/session

4. Tokenization - Operation 11: Delete Token DELETE https://{{domain}}/api/rest/version/{{collectionVersion}}/merchant/{{merchantId}}/token/{{tokenIdForPay}}?correlationId=correlationIdtest

5. Apple Pay-AMEX - Operation 1: Create Payment Session POST https://{{domain}}/api/rest/version/{{collectionVersion}}/merchant/{{merchantId}}/session

6. Apple Pay-AMEX - Operation 2: Update Session PUT https://{{domain}}/api/rest/version/{{collectionVersion}}/merchant/{{merchantId}}/session/{{sessionId}}

7. Apple Pay - Operation 1: Create Payment Session POST https://{{domain}}/api/rest/version/{{collectionVersion}}/merchant/{{merchantId}}/session

8. Apple Pay-AMEX - Operation 3: Pay PUT https://{{domain}}/api/rest/version/{{collectionVersion}}/merchant/{{merchantId}}/order/{{paymentSessionOrderId}}/transaction/{{payTransactionId}}

9. Refund - Operation 2: Refund PUT https://{{domain}}/api/rest/version/{{collectionVersion}}/merchant/{{merchantId}}/order/{{orderIdForRefund}}/transaction/{{refundTransactionId}}

10. Refund - Operation 1: Pay Transaction PUT https://{{domain}}/api/rest/version/{{collectionVersion}}/merchant/{{merchantId}}/order/{{orderIdForRefund}}/transaction/{{payTransactionId1}}