post
https://dev-api.shabaas.com/api/public/payment_agreement
Create a PayTo payment agreement.
Sandbox PayID suggestions
On Staging, use one of these pay_id values for the matching type. Production requires a real PayID.
| type | Suggested pay_id |
|---|---|
[email protected], [email protected] | |
| phone | 61491570006, 61491570156 |
| abn | 12345678901, 13579246810 |
| org | 123456789, 135792468 |
Error Codes
| Code | Status | Reason | What to do |
|---|---|---|---|
| PAM_PAYER_ID_TYPE_FORBIDDEN | 400 | LinkedPayIdType prohibited without linkedPayID | Include pay_id |
| PAM_PAYER_BSB_REQUIRED | 400 | Payer BSB required when not using a PayID | Use bsb + account_number for bank payers, or switch to type: email / phone with pay_id for PayID. |
| PAM_REQUEST_EMPTY | 400 | Request payload is empty | Send payment_agreement object with required fields. |
| PAM_VALIDATION_ERROR | 400 | Request validation failed | Correct invalid/missing fields and retry. |
| PAM_PAYEE_MISSING | 400 | Payee details are missing | Provide PayID or valid account details. |
| PAM_PAYEE_ACCT_MISSING | 400 | Payee account details are missing | Include both BSB and account number when required. |
| PAM_PAYEE_BSB_INVALID | 400 | Payee BSB is invalid | Use a valid 6-digit BSB. |
| PAM_PAYEE_ACCT_INVALID | 400 | Payee account number is invalid | Provide a valid account number. |
| PAM_PMT_FREQ_INVALID | 400 | Frequency value is invalid | Use one of supported frequency values. |
| PAM_PAG_LIMIT_EXCEEDED | 400 | Merchant agreement limit exceeded | Reduce request volume or increase limit. |
| M101 | 422 | Amount exceeds platform single-agreement threshold | Reduce maximum_amount to supported threshold. |
| M100 | 422 | Amount exceeds merchant agreement limit | Update merchant limits or lower maximum_amount. |
| MOV_NPP_PAYMENT_NOT_SUPPORTED | 422 | Payee account cannot receive NPP payments | Use a valid PayID/account that can receive NPP payments. |
| MOV_PAYEE_DETAIL_ERROR | 404 | Payee details are incorrect | Correct PayID/BSB/account details. |
| MOV_INVALID_BSB | 400 | BSB is invalid | Provide a valid BSB and retry. |
| MOV_REQUEST_TIMEOUT | 408 | Provider request timed out | Retry with backoff and poll status if needed. |
| VALIDATION_ERROR | 422 | Invalid request fields (for example frequency) | Correct payload format and accepted enum values. |
| CREDITS_EXHAUSTED | 402 | Developer credits exhausted | Top up developer credits and retry. |
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…