Skip to main content
POST
payments.mandate.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

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 who owns the authorization.

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

Authorization id from a mandate list.

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

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_-]+$