Skip to main content
POST
payments.mandate.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
customerId
string
required

Customer giving the authorization.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
method
enum<string>
required

Bank debit consent or an existing wallet billing agreement.

Available options:
bank_debit,
wallet
consumerName
string
required

Name of the customer who gave consent.

Required string length: 1 - 200
bankAccount
string

IBAN for bank debit, sent once; never returned.

Required string length: 1 - 34
Pattern: ^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$
bankCode
string

Optional bank BIC, sent once.

Required string length: 1 - 11
Pattern: ^[A-Z0-9]{8}([A-Z0-9]{3})?$
consumerEmail
string

Customer email for a wallet authorization, sent once.

Required string length: 1 - 320
Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+$
agreementId
string

Existing wallet billing agreement credential, sent once; never returned.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
vaultId
string

Existing wallet vault credential, sent once; never returned.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
signatureDate
string

Date the customer signed, YYYY-MM-DD.

Required string length: 1 - 10
Pattern: ^\d{4}-\d{2}-\d{2}$
reference
string

Unique consent reference in your business records.

Required string length: 1 - 128
maxAmount
object

Most one collection under this mandate may take, in minor units. An account that cannot enforce it refuses before anything is created.

frequency
enum<string>

How often collections may happen; as_presented has no fixed schedule.

Available options:
day,
week,
month,
year,
as_presented
startDate
string

First day collections may happen, YYYY-MM-DD.

Required string length: 1 - 10
Pattern: ^\d{4}-\d{2}-\d{2}$
endDate
string

Last day collections may happen, YYYY-MM-DD.

Required string length: 1 - 10
Pattern: ^\d{4}-\d{2}-\d{2}$

Response

The result

mandateId
string
required

Mandate id in your connected payment account.

customerId
string
required

Customer who gave the authorization.

status
enum<string>
required

Authorization state; unknown values remain unknown.

Available options:
valid,
pending,
invalid,
unknown
method
enum<string>
required

Payment method category.

Available options:
bank_debit,
card,
wallet,
unknown
createdAt
string

Creation time, ISO 8601.

signatureDate
string

Date the customer signed, ISO 8601 UTC.

maxAmount
object

Most one collection under this mandate may take, in minor units.

frequency
enum<string>

How often collections may happen; as_presented has no fixed schedule.

Available options:
day,
week,
month,
year,
as_presented
startDate
string

First day collections may happen, YYYY-MM-DD.

Required string length: 1 - 10
Pattern: ^\d{4}-\d{2}-\d{2}$
endDate
string

Last day collections may happen, YYYY-MM-DD.

Required string length: 1 - 10
Pattern: ^\d{4}-\d{2}-\d{2}$
authorizationUrl
string

Platform link where the customer authorizes the mandate, while one is pending.

Maximum string length: 512
Pattern: ^https?:\/\/[^/?#\s]+\/connect\/link\/[A-Za-z0-9_-]+$