Payment Rules Service¶

Retrieve Buyer Account Card Exclusion/Inclusion List¶

Endpoint: https://arc-aegis.billtrust.com/payment-acceptance-rules/v1/tenants/{tenantId}/paymentsettings/card/buyeraccounts

Method: GET

Description: Retrieves the list of buyer accounts on the credit card inclusion/exclusion list

Example Request¶

curl -X GET 'https://arc-aegis.billtrust.com/payment-acceptance-rules/v1/tenants/{tenantId}/paymentsettings/card/buyeraccounts' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'X-Billtrust-Api-Key: <API key value>'

Example Response¶

{
  "status": "string",
  "correlationId": "string",
  "errors": [
    "string"
  ],
  "restrictionType": "Exclusion",
  "buyerAccounts": [
    "BUYER1", "BUYER2"
  ],
  "overrideRestriction": true
}

Field	Description
restrictionType	Inclusion = only accounts on the list allow credit card payments, Exclusion = accounts on the list do not allow credit card payments, NoRestriction = all accounts allow credit card payments
buyerAccounts	An array of the buyer account numbers in the list
overrideRestriction	Whether overrides of a restricted account are allowed for users with the Manager role; defaults to false
status	Can be ignored
correlationId	Internal ID only used by Billtrust; can be ignored

Update Buyer Account Card Exclusion/Inclusion List¶

Endpoint: https://arc-aegis.billtrust.com/payment-acceptance-rules/v1/tenants/{tenantId}/paymentsettings/card/buyeraccounts

Method: PUT

Description: Updates the list of buyer accounts on the credit card inclusion/exclusion list.

Example Request¶

curl -X PUT 'https://arc-aegis.billtrust.com/payment-acceptance-rules/v1/tenants/{tenantId}/paymentsettings/card/buyeraccounts' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'X-Billtrust-Api-Key: <API key value>' \
    -d '{ "restrictionType": "Exclusion", "buyerAccounts": ["BUYER1", "BUYER2"], "overrideRestriction": true }'

Field	Description
restrictionType	Accepted values are: Inclusion = only accounts on the list allow credit card payments, Exclusion = accounts on the list do not allow credit card payments, NoRestriction = all accounts allow credit card payments
buyerAccounts	An array of buyer account numbers to be added; each value should be of type string; List may not exceed 10,000 account numbers per request
overrideRestriction	Whether overrides of a restricted account are allowed for users with the Manager role; defaults to false

Example Response¶

{
  "status": "string",
  "correlationId": "string",
  "errors": [
    "string"
  ],
  "duplicateBuyerAccounts": [
    "string"
  ]
}

Field	Description
duplicateBuyerAccounts	These buyer accounts were already present on the list and so were not added

Delete from Buyer Account Card Exclusion/Inclusion List¶

Endpoint: https://arc-aegis.billtrust.com/payment-acceptance-rules/v1/tenants/{tenantId}/paymentsettings/card/buyeraccounts

Method: DELETE

Description: Deletes the provided accounts from the list of buyer accounts on the credit card inclusion/exclusion list

Example Request¶

curl -X DELETE 'https://arc-aegis.billtrust.com/payment-acceptance-rules/v1/tenants/{tenantId}/paymentsettings/card/buyeraccounts' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'X-Billtrust-Api-Key: <API key value>' \
    -d '{ "buyerAccounts": ["BUYER1", "BUYER2"] }'

Field	Description
buyerAccounts	An array of buyer account numbers to be deleted

Example Response¶

{
  "status": "string",
  "correlationId": "string",
  "errors": [
    "string"
  ]
}

Common Error Codes¶

Response Code	Description	Resolution
400 Bad Request	The request is malformed	Check your request payload to make sure the format and values are appropriate
401 Unauthorized	The API Key used is expired or invalid	Follow the instructions here to generate a valid API Key
403 Forbidden	The API Key doesn't have the correct permission	Make sure the user account associated with the API Key is given the Payments Admin role
404 Not Found	The resource doesn't exist	Use the PUT endpoint to create the buyer account list
500 Internal Server Error	An internal error has occurred that has prevented the request from being completed	Reach out to Billtrust support

---¶

Retrieve Surcharging Buyer Account Exclusion/Inclusion List¶

Endpoint: https://arc-aegis.billtrust.com/payment-acceptance-rules/v1/tenants/{tenantId}/paymentsettings/surcharging/buyeraccounts

Method: GET

Description: Retrieves the list of buyer accounts on the surcharging inclusion/exclusion list

Example Request¶

curl -X GET 'https://arc-aegis.billtrust.com/payment-acceptance-rules/v1/tenants/{tenantId}/paymentsettings/surcharging/buyeraccounts' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'X-Billtrust-Api-Key: <API key value>'

Example Response¶

{
  "status": "string",
  "correlationId": "string",
  "errors": [
    "string"
  ],
  "restrictionType": "Exclusion",
  "buyerAccounts": [
    "BUYER1", "BUYER2"
  ]
}

Field	Description
restrictionType	Inclusion = only accounts on the list allow surcharges, Exclusion = accounts on the list do not allow surcharges, NoRestriction = all accounts allow surcharges
buyerAccounts	An array of the buyer account numbers in the list
status	Can be ignored
correlationId	Internal ID only used by Billtrust; can be ignored

Common Error Codes¶

Response Code	Description	Resolution
400 Bad Request	The request is malformed	Check your request payload to make sure the format and values are appropriate
401 Unauthorized	The API Key used is expired or invalid	Follow the instructions here to generate a valid API Key
403 Forbidden	The API Key doesn't have the correct permission	Make sure the user account associated with the API Key is given the Payments Admin role
404 Not Found	The resource doesn't exist	Use the PUT endpoint to create the surcharging buyer account list
500 Internal Server Error	An internal error has occurred that has prevented the request from being completed	Reach out to Billtrust support

Update Surcharging Buyer Account Exclusion/Inclusion List¶

Endpoint: https://arc-aegis.billtrust.com/payment-acceptance-rules/v1/tenants/{tenantId}/paymentsettings/surcharging/buyeraccounts

Method: PUT

Description: Updates the list of buyer accounts on the surcharging inclusion/exclusion list.

Example Request¶

curl -X PUT 'https://arc-aegis.billtrust.com/payment-acceptance-rules/v1/tenants/{tenantId}/paymentsettings/surcharging/buyeraccounts' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'X-Billtrust-Api-Key: <API key value>' \
    -d '{ "restrictionType": "Exclusion", "buyerAccounts": ["BUYER1", "BUYER2"] }'

Field	Description
restrictionType	Accepted values are: Inclusion = only accounts on the list allow surcharges, Exclusion = accounts on the list do not allow surcharges, NoRestriction = all accounts allow surcharges
buyerAccounts	An array of buyer account numbers to be added; each value should be of type string; List may not exceed 10,000 account numbers per request

Example Response¶

{
  "status": "string",
  "correlationId": "string",
  "errors": [
    "string"
  ],
  "duplicateBuyerAccounts": [
    "string"
  ]
}

Field	Description
duplicateBuyerAccounts	These buyer accounts were already present on the list and so were not added

Delete from Buyer Account Surcharging Exclusion/Inclusion List¶

Endpoint: https://arc-aegis.billtrust.com/payment-acceptance-rules/v1/tenants/{tenantId}/paymentsettings/surcharging/buyeraccounts

Method: DELETE

Description: Deletes the provided accounts from the list of buyer accounts on the surcharging inclusion/exclusion list

Example Request¶

curl -X DELETE 'https://arc-aegis.billtrust.com/payment-acceptance-rules/v1/tenants/{tenantId}/paymentsettings/surcharging/buyeraccounts' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'X-Billtrust-Api-Key: <API key value>' \
    -d '{ "buyerAccounts": ["BUYER1", "BUYER2"] }'

Field	Description
buyerAccounts	An array of buyer account numbers to be deleted

Example Response¶

{
  "status": "string",
  "correlationId": "string",
  "errors": [
    "string"
  ]
}

Common Error Codes¶

Response Code	Description	Resolution
400 Bad Request	The request is malformed	Check your request payload to make sure the format and values are appropriate
401 Unauthorized	The API Key used is expired or invalid	Follow the instructions here to generate a valid API Key
403 Forbidden	The API Key doesn't have the correct permission	Make sure the user account associated with the API Key is given the Payments Admin role
404 Not Found	The resource doesn't exist	Use the PUT endpoint to create the buyer account list
500 Internal Server Error	An internal error has occurred that has prevented the request from being completed	Reach out to Billtrust support