PomeloEx.Finance.Settlements (PomeloEx v0.1.0)

View Source

Financial settlement management.

Provides endpoints for querying available balances by country and currency, notifying deposits (with receipt upload), retrieving the latest settlement, and receiving new settlement webhook notifications.

Summary

Functions

Get balances The /finance/v1/balances endpoint retrieves the available balances for the authenticated client by country.

Get last settlement The /finance/v1/settlements/latest endpoint retrieves the latest available settlement for the authenticated client by country.

New settlement Webhook that notifies when a new settlement is generated for the client.

Notify deposit The /finance/v1/deposits endpoint notifies a deposit for the authenticated client. The request should be sent as multipart/form-data to include the receipt file along with the form fields.

Functions

get_balances(payload)

Get balances The /finance/v1/balances endpoint retrieves the available balances for the authenticated client by country.

get_last_settlement(payload)

Get last settlement The /finance/v1/settlements/latest endpoint retrieves the latest available settlement for the authenticated client by country.

new_settlement(payload)

New settlement Webhook that notifies when a new settlement is generated for the client.

You must include this endpoint in your service so that we can provide you with real-time settlement updates.

Considerations

  • We expect a response in the 2XX range to ensure that you've received the notification. Otherwise, we'll resend it.

notify_deposit(payload)

Notify deposit The /finance/v1/deposits endpoint notifies a deposit for the authenticated client. The request should be sent as multipart/form-data to include the receipt file along with the form fields.