Yabetoo

https://docs.yabetoopay.com
Admin
Yabetoo fournit une infrastructure de paiement complète pour les entreprises en Afrique. Acceptez...
Tokens:2,343
Snippets:29
Trust Score:4.8
Update:3 months ago
Show doc for...
Tokens:
Raw
### Get Disbursement

Source: https://docs.yabetoopay.com/llms.txt

Retrieves the details of a disbursement by its ID. Use this to check the status and details of a past disbursement.

```APIDOC
## GET /payments/disbursement/get

### Description
Retrieves a disbursement by its ID.

### Method
GET

### Endpoint
/payments/disbursement/get

### Query Parameters
- **disbursement_id** (string) - Required - The ID of the disbursement to retrieve.

### Response
#### Success Response (200)
- **disbursement_id** (string) - The unique ID for the disbursement.
- **amount** (number) - The amount disbursed.
- **currency** (string) - The currency of the disbursement.
- **recipient_account** (string) - The account details of the recipient.
- **status** (string) - The current status of the disbursement.
- **created_at** (string) - The timestamp when the disbursement was created.
```

--------------------------------

### Get Money Remittance

Source: https://docs.yabetoopay.com/llms.txt

Retrieves a money remittance by its ID to check its status and details. Useful for tracking outgoing funds.

```APIDOC
## GET /payments/remittance/get

### Description
Retrieves a money remittance by its ID.

### Method
GET

### Endpoint
/payments/remittance/get

### Query Parameters
- **remittance_id** (string) - Required - The ID of the remittance to retrieve.

### Response
#### Success Response (200)
- **remittance_id** (string) - The unique ID for the remittance.
- **beneficiary_details** (object) - Information about the beneficiary.
  - **name** (string) - Beneficiary's full name.
  - **account_number** (string) - Beneficiary's account number.
  - **bank_code** (string) - The code of the beneficiary's bank.
- **amount** (number) - The amount remitted.
- **currency** (string) - The currency of the remittance.
- **status** (string) - The current status of the remittance.
- **created_at** (string) - The timestamp when the remittance was created.
```

--------------------------------

### Create Payment Link

Source: https://docs.yabetoopay.com/llms.txt

Creates a reusable payment link to collect payments. These links can be shared with customers to facilitate easy payments.

```APIDOC
## POST /payments/payment-link/create

### Description
Creates a reusable payment link to collect payments.

### Method
POST

### Endpoint
/payments/payment-link/create

### Request Body
- **amount** (number) - Required - The amount to be collected.
- **currency** (string) - Required - The currency of the payment.
- **description** (string) - Optional - A description for the payment link.
- **expiry_date** (string) - Optional - The date and time when the payment link expires (ISO 8601 format).

### Response
#### Success Response (200)
- **link_id** (string) - The unique ID for the created payment link.
- **url** (string) - The URL of the payment link.
```

--------------------------------

### Create Payment Intent

Source: https://docs.yabetoopay.com/llms.txt

Creates a payment intent to process a payment. This initiates the payment process and generates a unique payment intent ID.

```APIDOC
## POST /payments/api/create

### Description
Creates a payment intent to process a payment.

### Method
POST

### Endpoint
/payments/api/create

### Request Body
- **amount** (number) - Required - The amount to be paid.
- **currency** (string) - Required - The currency of the payment (e.g., 'USD', 'EUR').
- **customer_id** (string) - Optional - The ID of the customer making the payment.
- **description** (string) - Optional - A description of the payment.

### Response
#### Success Response (200)
- **payment_intent_id** (string) - The unique ID for the created payment intent.
- **client_secret** (string) - A secret key used for client-side operations.
```

--------------------------------

### Create Checkout Session

Source: https://docs.yabetoopay.com/llms.txt

Creates a checkout session to redirect customers to the Yabetoo hosted payment page. This is used for a seamless checkout experience.

```APIDOC
## POST /payments/checkout-page/create

### Description
Creates a checkout session to redirect your customers to the Yabetoo hosted payment page.

### Method
POST

### Endpoint
/payments/checkout-page/create

### Request Body
- **line_items** (array) - Required - A list of items to be purchased.
  - **price_data** (object) - Required - Price information for the item.
    - **currency** (string) - Required - The currency of the price.
    - **unit_amount** (number) - Required - The price of the item in the smallest currency unit.
    - **product_data** (object) - Required - Product information.
      - **name** (string) - Required - The name of the product.
  - **quantity** (number) - Required - The quantity of the item.
- **success_url** (string) - Required - The URL to redirect to after a successful payment.
- **cancel_url** (string) - Required - The URL to redirect to if the payment is cancelled.

### Response
#### Success Response (200)
- **id** (string) - The ID of the checkout session.
- **url** (string) - The URL to redirect the customer to for payment.
```

--------------------------------

### Share Payment Link

Source: https://docs.yabetoopay.com/llms.txt

Provides methods and best practices for sharing payment links with customers to ensure successful payment collection.

```APIDOC
## POST /payments/payment-link/share

### Description
Provides methods for sharing payment links.

### Method
POST

### Endpoint
/payments/payment-link/share

### Request Body
- **link_id** (string) - Required - The ID of the payment link to share.
- **sharing_method** (string) - Required - The method to use for sharing (e.g., 'email', 'sms', 'qr_code').
- **recipient_details** (object) - Required - Details of the recipient.
  - **email** (string) - Optional - Recipient's email address.
  - **phone_number** (string) - Optional - Recipient's phone number.

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the link has been shared.
- **status** (string) - The status of the sharing operation.
```

--------------------------------

### Create Disbursement

Source: https://docs.yabetoopay.com/llms.txt

Creates a disbursement to transfer funds from your account to a customer's account. This is used for payouts or refunds.

```APIDOC
## POST /payments/disbursement/create

### Description
Creates a disbursement to transfer funds from your account to a customer's account.

### Method
POST

### Endpoint
/payments/disbursement/create

### Request Body
- **amount** (number) - Required - The amount to disburse.
- **currency** (string) - Required - The currency of the disbursement.
- **recipient_account** (string) - Required - The account details of the recipient.
- **reference** (string) - Optional - A reference for the disbursement.

### Response
#### Success Response (200)
- **disbursement_id** (string) - The unique ID for the created disbursement.
- **status** (string) - The initial status of the disbursement.
```

--------------------------------

### Create Money Remittance

Source: https://docs.yabetoopay.com/llms.txt

Sends money to a beneficiary on behalf of a user via your Yabetoo business account. Used for various payout scenarios.

```APIDOC
## POST /payments/remittance/create

### Description
Sends money to a beneficiary for a user via your Yabetoo business account.

### Method
POST

### Endpoint
/payments/remittance/create

### Request Body
- **beneficiary_details** (object) - Required - Information about the beneficiary.
  - **name** (string) - Required - Beneficiary's full name.
  - **account_number** (string) - Required - Beneficiary's account number.
  - **bank_code** (string) - Required - The code of the beneficiary's bank.
- **amount** (number) - Required - The amount to remit.
- **currency** (string) - Required - The currency of the remittance.
- **user_reference** (string) - Optional - A reference provided by the user.

### Response
#### Success Response (200)
- **remittance_id** (string) - The unique ID for the created remittance.
- **status** (string) - The initial status of the remittance.
```

--------------------------------

### Confirm Payment Intent

Source: https://docs.yabetoopay.com/llms.txt

Confirms a payment intent to process a payment. This is a crucial step after creating a payment intent to finalize the transaction.

```APIDOC
## POST /payments/api/confirm

### Description
Confirms a payment intent to process a payment.

### Method
POST

### Endpoint
/payments/api/confirm

### Request Body
- **payment_intent_id** (string) - Required - The ID of the payment intent to confirm.
- **transaction_id** (string) - Required - The ID of the transaction associated with the payment intent.

### Response
#### Success Response (200)
- **status** (string) - The status of the payment confirmation.
- **message** (string) - A confirmation message.
```
Tokens:
Raw