ACH Tokens

Get ACH stored token by Id

get

Retrieve the details of a stored ACH token using the specified token ID.

Path parameters

tokenIdstringRequired

Specifies the unique identifier of the ACH token.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Responses

200

Success

Payload

payloadTypestringOptional

Indicates the type of payload returned in the response.

400

Bad Request

401

Unauthorized

402

Business Exception

403

Forbidden

404

Not Found

500

Internal server error

get/rest/v2/ach/tokens/{tokenId}

GET /rest/v2/ach/tokens/{tokenId} HTTP/1.1
api-key: text
Accept: */*

{
  "ach-token": {
    "token-id": "1100000000000000",
    "times-used": 14,
    "last-used": "1100000000000000",
    "merchant-id": "000008888",
    "routing-number": "081009813",
    "account-number": "1111",
    "account-type": "Checking",
    "individual-name": "John Doe",
    "token-description": "Travel checking account",
    "created": "1100000000000000",
    "updated": "1100000000000000",
    "customer-key": "customer123",
    "default": false
  },
  "payloadType": "text"
}

Update ACH token by Id

put

Update the details of an existing ACH token identified by the specified token ID.

Path parameters

tokenIdstringRequired

Specifies the unique identifier of the ACH token.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Body

Use this model when creating a new ach token

routing-numberstringRequired

Specifies the bank routing number used to create the ACH token.

Example: 081009813

account-numberstringRequired

Specifies the bank account number (1 to 17 digits) used to create the ACH token.

Example: 123456789

account-typestring · enumRequired

Specifies the type of bank account. Possible values: Checking, Savings.

Example: CheckingPossible values:

individual-namestringRequired

Specifies the name of the bank account holder.

Example: John Doe

token-descriptionstringOptional

Provides a description for the ACH token.

Example: Business checking account

customer-keystringOptional

Identifies the customer associated with the ACH token.

Example: customer123

defaultbooleanOptional

Indicates whether this token is the default payment method for the customer.

Example: false

software-typestringRequired

Identifies the software application.

Example: MySoftware

software-type-versionstringRequired

Specifies the version of the software application.

Example: v1.0

check-digit-enabledbooleanOptional

Indicates whether the check-digit validation algorithm is enabled for New Zealand (NZ) bank accounts.

Example: false

Responses

200

Successful Token Update

Payload

payloadTypestringOptional

Indicates the type of payload returned in the response.

400

Bad Request

401

Unauthorized

402

Business Exception

403

Forbidden

404

Not Found

500

Internal server error

put/rest/v2/ach/tokens/{tokenId}

PUT /rest/v2/ach/tokens/{tokenId} HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 295

{
  "routing-number": "081009813",
  "account-number": "123456789",
  "account-type": "Checking",
  "individual-name": "John Doe",
  "token-description": "Business checking account",
  "customer-key": "customer123",
  "default": false,
  "software-type": "MySoftware",
  "software-type-version": "v1.0",
  "check-digit-enabled": false
}

{
  "ach-token": {
    "token-id": "1100000000000000",
    "times-used": 14,
    "last-used": "1100000000000000",
    "merchant-id": "000008888",
    "routing-number": "081009813",
    "account-number": "1111",
    "account-type": "Checking",
    "individual-name": "John Doe",
    "token-description": "Travel checking account",
    "created": "1100000000000000",
    "updated": "1100000000000000",
    "customer-key": "customer123",
    "default": false
  },
  "payloadType": "text"
}

Delete ACH transaction token by Id

delete

Delete the ACH token identified by the specified token ID.

Path parameters

tokenIdstringRequired

Specifies the unique identifier of the ACH token.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Responses

200

Success

Payload

payloadTypestringOptional

Indicates the type of payload returned in the response.

400

Bad Request

401

Unauthorized

402

Business Exception

403

Forbidden

500

Internal server error

delete/rest/v2/ach/tokens/{tokenId}

DELETE /rest/v2/ach/tokens/{tokenId} HTTP/1.1
api-key: text
Accept: */*

{
  "ach-token": {
    "token-id": "1100000000000000",
    "times-used": 14,
    "last-used": "1100000000000000",
    "merchant-id": "000008888",
    "routing-number": "081009813",
    "account-number": "1111",
    "account-type": "Checking",
    "individual-name": "John Doe",
    "token-description": "Travel checking account",
    "created": "1100000000000000",
    "updated": "1100000000000000",
    "customer-key": "customer123",
    "default": false
  },
  "payloadType": "text"
}

Create ACH transaction token

post

Create a reusable ACH token by securely storing a customer's bank account details.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Body

Use this model when creating a new ach token

routing-numberstringRequired

Specifies the bank routing number used to create the ACH token.

Example: 081009813

account-numberstringRequired

Specifies the bank account number (1 to 17 digits) used to create the ACH token.

Example: 123456789

account-typestring · enumRequired

Specifies the type of bank account. Possible values: Checking, Savings.

Example: CheckingPossible values:

individual-namestringRequired

Specifies the name of the bank account holder.

Example: John Doe

token-descriptionstringOptional

Provides a description for the ACH token.

Example: Business checking account

customer-keystringOptional

Identifies the customer associated with the ACH token.

Example: customer123

defaultbooleanOptional

Indicates whether this token is the default payment method for the customer.

Example: false

software-typestringRequired

Identifies the software application.

Example: MySoftware

software-type-versionstringRequired

Specifies the version of the software application.

Example: v1.0

check-digit-enabledbooleanOptional

Indicates whether the check-digit validation algorithm is enabled for New Zealand (NZ) bank accounts.

Example: false

Responses

200

Successful Token Creation

Payload

payloadTypestringOptional

Indicates the type of payload returned in the response.

400

Bad Request

401

Unauthorized

402

Business Exception

403

Forbidden

404

Not Found

500

Internal server error

post/rest/v2/ach/tokens

POST /rest/v2/ach/tokens HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 295

{
  "routing-number": "081009813",
  "account-number": "123456789",
  "account-type": "Checking",
  "individual-name": "John Doe",
  "token-description": "Business checking account",
  "customer-key": "customer123",
  "default": false,
  "software-type": "MySoftware",
  "software-type-version": "v1.0",
  "check-digit-enabled": false
}

{
  "ach-token": {
    "token-id": "1100000000000000",
    "times-used": 14,
    "last-used": "1100000000000000",
    "merchant-id": "000008888",
    "routing-number": "081009813",
    "account-number": "1111",
    "account-type": "Checking",
    "individual-name": "John Doe",
    "token-description": "Travel checking account",
    "created": "1100000000000000",
    "updated": "1100000000000000",
    "customer-key": "customer123",
    "default": false
  },
  "payloadType": "text"
}