Overview
User management
- Users
- User regulatory status
- User e-money
User verification
- User data format
- KYC documents
- UBO declarations
Wallets
- User wallets
- Client wallets
Cards
- Card registrations
- Cards
- Metadata
- Card validations
Card pay-ins
- Direct card pay-ins
- Recurring card pay-ins
- Preauthorizations
- Deposit preauthorizations
- Web card pay-ins
Banking pay-ins
- Bank wires
- Virtual IBAN
- Direct debits
- Web direct debits
APM pay-ins
- Apple Pay
- Bancontact
- BLIK
- Giropay
- Google Pay
- iDEAL
- Klarna
- MB WAY
- Multibanco
- Payconiq
- PayPal
- Satispay
- Swish
- TWINT
Transfers
- Transfers
Refunds
- Refunds
Disputes
- Disputes
- Dispute documents
- Repudiations
- Dispute settlement
Payouts
- Bank accounts
- Payouts
FX conversions
- Conversion rates
- Quotes
- Conversions
Transactions
- Transactions
Helpers
- API responses
- Country authorizations
- Webhooks
- Events
- Reports
Platform account
- Client
- Dashboard permissions
Create a Hook
{
"Url": "https://example.com",
"EventType" : "PAYIN_REFUND_SUCCEEDED",
"Tag": "Created using the Mangopay API Postman Collection"
}
{
"Url": "https://example.com",
"Status": "ENABLED",
"Validity": "VALID",
"EventType": "PAYIN_REFUND_SUCCEEDED",
"Id": "hook_m_01J8F5RK4R43AYWD8XVG9RSYDT",
"Tag": "Created using the Mangopay API Postman Collection",
"CreationDate": 1727086218
}
Note
You can only create one Hook for each EventType.
Body parameters
Allowed values: An EventType listed in the event types list
The type of the event.
Max. length: 255 characters
The URL to which the notification is sent.
Max. length: 255 characters
Custom data that you can add to this object.
Responses
Max. length: 255 characters
The URL to which the notification is sent.
Returned values: DISABLED, ENABLED
Whether the hook is enabled or not.
Returned values: VALID, INVALID
Whether the hook is valid or not. Once INVALID (following unsuccessful retries) the hook must be disabled and re-enabled.
Returned values: An EventType listed in the event types list
The type of the event.
The unique identifier of the object.
Max. length: 255 characters
Custom data that you can add to this object.
The date and time at which the object was created.
{
"Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
"Type": "param_error",
"Id": "829f2782-85a9-45b1-a2bd-993b0978c5bc",
"Date": 1690295313.0,
"errors": {
"EventType": "A hook has already been registered for this EventType"
}
}
{
"Url": "https://example.com",
"Status": "ENABLED",
"Validity": "VALID",
"EventType": "PAYIN_REFUND_SUCCEEDED",
"Id": "hook_m_01J8F5RK4R43AYWD8XVG9RSYDT",
"Tag": "Created using the Mangopay API Postman Collection",
"CreationDate": 1727086218
}
{
"Url": "https://example.com",
"EventType" : "PAYIN_REFUND_SUCCEEDED",
"Tag": "Created using the Mangopay API Postman Collection"
}
Was this page helpful?
{
"Url": "https://example.com",
"EventType" : "PAYIN_REFUND_SUCCEEDED",
"Tag": "Created using the Mangopay API Postman Collection"
}
{
"Url": "https://example.com",
"Status": "ENABLED",
"Validity": "VALID",
"EventType": "PAYIN_REFUND_SUCCEEDED",
"Id": "hook_m_01J8F5RK4R43AYWD8XVG9RSYDT",
"Tag": "Created using the Mangopay API Postman Collection",
"CreationDate": 1727086218
}