Pay To Send Agreement

Send agreement request to customer

SecurityMarketplace API Key | Merchant Public Token | Merchant Secret Token | Customer JWT | Merchant JWT | Marketplace JWT | Admin JWT
Request
header Parameters
Merchant-Id
string

Perform operation in the context of the given merchant. Usually not required — specify only if acting on behalf of a merchant not implied by the credentials specified in the Authorization header.

Customer-Id
string

Perform operation in the context of the given merchant customer. Usually not required — specify only if acting on behalf of a merchant customer not implied by the credentials specified in the Authorization header.

Request Body schema: application/json
required
customerName
required
string

Name associated to the account to be charged

required
Alias (object) or Bban (object) (AccountIdentifier)
required
AgreementRequestTermsOneOff (object) or AgreementRequestTermsOpen (object) (AgreementRequestTerms)
purpose
string (Purpose)

Purpose of the payment. If not specified retail will be used by default

Enum: "Mortgage" "Utility" "Loan" "DependantSupport" "Gambling" "Retail" "Salary" "Personal" "Government" "Pension" "Tax" "Other"
Responses
200
400
401
403
404
405
406
409
422
429
500
503
post/payto/agreement
Request samples
application/json
{
  • "customerName": "string",
  • "customerAccIdentifier": {
    },
  • "terms": {
    },
  • "purpose": "Mortgage"
}
Response samples
application/json
{
  • "token": "string"
}
Copyright © April Solutions 2023. All right reserved.