Citcon through Afterpay integration guide

Citcon through Afterpay logo Citcon through Afterpay is a payment provider allowing customers to pay using supported wallet apps on their mobile device. This guide is intended to help you implement Citcon through Afterpay based on your preferred integration workflow.

Services and compatibility

Payment method gateway nameAfterpay
Supported transaction types
Supported integration methods
Supported processing currenciesCAD, USD
Webhook event types
  • TRANSACTION_AUTHORIZED
  • TRANSACTION_CAPTURED
  • TRANSACTION_REFUNDED
  • TRANSACTION_SETTLED

Gateway-specific information

Nexio does not need any additional gateway information. However, you can see the Afterpay website, if needed.

Configuration

Apart from working with Integrations to add Citcon through Afterpay as a payment method, you do not need to do any other configuration steps.

Required fields

The following table shows the required and optional fields for Citcon through Afterpay transactions in the Create APM one-time-use token request.

FieldRequired?Description
data.amountYesThe transaction amount.
data.currencyYesThe three-character ISO currency code for the transaction.
Supported currencies are CAD and USD.
data.customer.billToAddressOneYesThe street address for the customer.
data.customer.billToCityYesThe city for the address record.
data.customer.billToStateYesThe state or province on file with the payment provider. (If in the US, this must be the two-character state abbreviation).
data.customer.billToPostalYesThe postal code on file.
data.customer.billToCountryYesThe two-character (Alpha-2) ISO country code.
data.customer.billToPhoneYesThe billing phone number.
data.customer.emailYesThe customer's email address.
data.customer.firstNameYesThe customer's first name, as it is set for the payment method.
data.customer.lastNameYesThe customer's last name, as it is set for the payment method.
data.customer.orderNumberYesThe order number.
customerRedirectUrlNoThe URL to which the customer will be redirected after completing their payment. The customer will be sent here upon successful or failed payment. This URL must use the HTTPS protocol.
data.cart.items[n].itemNoItem number or code.
data.cart.items[n].descriptionNoA description of the item.
data.cart.items[n].quantityNoThe quantity sold.
data.cart.items[n].priceNoThe price per item.
data.customer.billToAddressTwoNoAdditional street address information, if required.
data.customer.customerRefNoCustomer identifier. You can use this field to pass a customer ID to the APM or to manage user subscriptions.
data.customer.invoiceNoThe invoice number.
data.customer.shipToAddressOneNoThe shipping address, if different from the billing address.
data.customer.shipToAddressTwoNoAdditional shipping address information, if required.
data.customer.shipToCityNoThe shipping city.
data.customer.shipToStateNoThe shipping state or province. (If in the US, this must be the two-character state abbreviation).
data.customer.shipToPostalNoThe shipping postal code.
data.customer.shipToCountryNoThe two-character (Alpha-2) ISO shipping country code.
data.customer.shipToPhoneNoThe shipping phone number.
data.customFieldsNoNexio stores information in custom fields and passes custom fields to the gateway.
data.descriptionNoA description of the transaction.
data.descriptorNoInclude this parameter to dynamically change the descriptor on the customer's statement.
data.paymentMethodNoThe identifier for the alternative payment method. Use this parameter when you want to only return the Citcon through Afterpay iframe button URL (rather than data for all payment methods associated with the account).

The value to use is citconAfterpay.
isAuthOnlyNoSet to true to run an auth only transaction.
processingOptions.merchantIdNoThe Nexio merchant ID (MID).
processingOptions.paymentOptionTagNoA custom value used to route transactions to a specific gateway or merchant account.
uiOptions.displaySubmitButtonNoSet to true to include a submit button in the iframe.
uiOptions.cssNoThe URL where your custom CSS file is hosted.

Example requests

The following is an example one-time-use token request for Citcon through Afterpay.

curl -X POST https://api.nexiopaysandbox.com/apm/v3/token \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Basic [Base64_encoded_login]'
  -d '{
  "data": {
    "amount": 4.00,
    "currency": "USD",
    "paymentMethod": "citconAfterpay",
    "customer": {
      "orderNumber": "210058A",
      "firstName": "John",
      "lastName": "Doe",
      "email": "[email protected]",
      "billToAddressOne": "2147 West Silverlake Drive",
      "billToCity": "Scranton",
      "billToState": "PA",
      "billToPostal": "18503", 
      "billToCountry": "US",
      "billToPhone": "1555555555"
    }
  }
}'

A successful request returns a response similar to the following:
{
  "expiration": "2023-09-18T15:43:05.664Z",
  "token": "830d36f6-a5e3-4455-9600-3a55b63e2fc2",
  "asyncTraceId": "830d36f6-a5e3-4455-9600-3a55b63e2fc2",
  "expressIFrameUrl": "https://www.api.nexiopaysandbox.com/v3?token=830d36f6-a5e3-4455-9600-3a55b63e2fc2",
  "redirectUrls": [
    {
      "paymentMethod": "citconAfterpay",
      "url": "https://api.nexiopaysandbox.com/apm/v3/popup?token=830d36f6-a5e3-4455-9600-3a55b63e2fc2&paymentMethod=citconAfterpay"
    }
  ],
  "buttonIFrameUrls": [
    {
      "paymentMethod": "sofortCheckout",
      "url": "https://api.nexiopaysandbox.com/apm/v3?token=830d36f6-a5e3-4455-9600-3a55b63e2fc2&paymentMethod=sofortCheckout"
    },
    {
      "paymentMethod": "citconAfterpay",
      "url": "https://api.nexiopaysandbox.com/apm/v3?token=830d36f6-a5e3-4455-9600-3a55b63e2fc2&paymentMethod=citconAfterpay"
    }
  ]
}

For the multi iframe integration method: You use the expressIFrameUrl value in the steps for the transaction.

For the individual iframe option: You use the buttonIFrameUrls.url (of the desired Citcon paymentMethod) for the transaction.

For the custom redirect option: You use redirectUrls.url of the Citcon paymentMethod for the transaction.

Transaction types and integration methods

Regardless of the integration method workflow you implement, consumers are redirected to Afterpay to complete their transactions.

Nexio supports the following transaction types for Citcon through Afterpay:

Testing data

Refer to the Citcon Development Tools documentation for testing card numbers and testing information.

Response handling

In the one-time-use token request, Citcon through Afterpay gets returned in the paymentMethod parameter as citconAfterpay.

Nexio responds with transaction results in one of the following ways, depending on your integration workflow:

  • Event messages: This applies to integrations that do not pass a customerRedirectUrl in the request.
  • Response fields in the URL: This applies to integrations that do provide a customerRedirectUrl in the request.

In addition to one of the above, if your merchant account is configured to receive webhooks, Nexio provides responses to the webhook URLs that have been registered. For further explanation of the webhook event types, see the webhook Event types table.

For Citcon through Afterpay, these are the possible webhook event types:

  • TRANSACTION_AUTHORIZED
  • TRANSACTION_CAPTURED
  • TRANSACTION_REFUNDED
  • TRANSACTION_SETTLED

For information about how to run each of the integration workflows, see Transaction types and integration methods above.

Status workflows

The status of a successful transaction with Citcon through Afterpay varies, depending on the options you choose.

SaleWhen isAuthOnly is false, successful sale transactions have the following statuses:
  • pending*
  • settled
Auth onlyWhen isAuthOnly is true, successful sale transactions have the following statuses:
  • authOnlyPending
  • authOnly
CaptureSuccessful capture transactions have the following status:
  • settled
RefundSuccessful refund transactions have the following status:
  • settled

*Pending status displays as "authorized" or "AUTHORIZED" in the Nexio Dashboard; it displays as 10, meaning "authorized", in the response when querying transactions (for more information about transactionStatus, see the table).

Next steps

Now, you are ready to get started with running transactions:

If you have any additional questions or feedback, see Contact us.