Documentation
HOMEAPI ReferencePayment Demo
English
English
  • 📖Home
  • API Reference
  • Wallet
    • Activate Account
    • Multi-currency Balance
    • Global Collection Account
    • Payout
    • Account settings
  • Payment
    • Get started
    • Accept a payment
      • Hosted payment page
      • In-page checkout
      • iOS
      • Android
      • API-Direct
    • Save a card during payment
      • iOS
      • Android
    • Pre-authorize a payment
    • 3D secure authentication
      • iOS
      • Android
    • Subscriptions
      • Recurring
    • Add payment methods
      • Supported APM codes and attributes list
      • APM Integration Guide
    • After the payment
      • Webhook
      • Refunds
      • Response handling
    • About the APIs
      • Currencies
      • Payments
        • How payments work
  • Business Operation
    • MoneyCollect dashboard
      • Home
      • Mobile apps
    • Account
      • Your account
      • Multiple Accounts
      • Account security
    • Alternative payment methods
      • Apply for APMs from your dashboard
        • Google pay
    • Customers
      • Customer portal
    • Products & Prices
      • Pricing table
    • Invoicing
      • How invoicing works
      • Use the dashboard
        • Customers
        • Products and prices
        • Invoice page
      • Hosted Invoice Page
      • No-code quickstart guide
    • Subscriptions
      • Subscription status
      • Subscription settings
      • Create a subscription
    • Pricing
      • Reserves
      • Fees for APMs
    • Payouts
    • Financial reports
      • Select preferred report
      • Balance summary
      • Payout reconciliation
    • Partners
      • Partner pricing
    • Risk management
      • Disputes
        • How disputes work
        • Respond to disputes
          • Dispute reasons
        • Measuring disputes
      • Fraud
        • Monitoring programs
        • High risk merchant lists
        • Tools
        • Fraud prevention
    • Start a team
      • Teams
      • User roles
    • Startup incorporation
  • Developer tools
    • API-Keys
    • Libraries
    • Plugins
      • WooCommerce
      • Magento
        • Using Magento 2 Admin Panel
      • Shopify
        • MoneyCollect Payments App
        • Legacy Version
          • Credit Card Direct Payments App
          • Credit Card Redirected Payments App
          • Alternative Payment Methods App
      • Wix
      • SHOPLINE
      • SHOPLAZZA
      • Xshoppy
      • ShopBase
      • PrestaShop
      • OpenCart
      • AllValue
        • Using Allvalue Panel
Powered by GitBook
On this page
  • Enabling Alternative Payment Methods (APMs)
  • Utilizing Payment Methods
  • Hosted Payment Page
  • In-Page Payment
  • API-Direct
  • Special Handling APMs (Wechat Pay/Kakao Pay)
  • Wechat Pay
  1. Payment
  2. Add payment methods

APM Integration Guide

PreviousSupported APM codes and attributes listNextAfter the payment

Last updated 8 months ago

Enabling Alternative Payment Methods (APMs)

To activate an alternative payment method on MoneyCollect, merchants can easily apply through their dashboard. This process involves toggling a switch to submit an application for the desired payment method, awaiting approval. Additional information might be required for some local payment methods, such as a local service phone number.

For detailed instructions, visit: .

Utilizing Payment Methods

Once your application for a payment method is approved, you can start integrating it into your payment processes.

Hosted Payment Page

To initiate a payment session via the API, you can follow the guide and API reference provided by MoneyCollect: .

Example request to create a session:

POST https://api.moneycollect.com/api/services/v1/checkout/session/create
{
  "paymentMethodTypes": ["card", "pix", "ame", "paypal"]
}

The paymentMethodTypes parameter allows specifying multiple payment methods. You can find the necessary payment method codes in the MoneyCollect documentation: .

Example response:

{
  "code": "success",
  "msg": "success",
  "data": {
    "id": "cs_17522182534xxxxx",
    "amountTotal": "990",
    "currency": "USD",
    "paymentMethodTypes": ["card", "pix", "ame", "paypal"],
    "cancelUrl": "http://localhost:4242/cancle.html",
    "returnUrl": "http://localhost:4242/return.html",
    "notifyUrl": "http://localhost:4242/notify.html",
    "orderNo": "order_id_123456",
    "website": "http://yourwebsite.org",
    "paymentId": "pt_17522182529xxxxxx",
    "url": "https://payment.moneycollect.com/checkout/cs_175221825xxxxxxxx#bGl2ZV9UhQUxxxxxxxxxx",
    "status": "unpaid",
    "created": "2022-01-30T06:32:40.932Z"
  }
}

After successfully creating a session, verify the amount, currency, and transaction status. Use the returned URL for the next step of the payment process, where customers choose a payment method and are redirected to the payment page.

In-Page Payment

For In-Page Payment integration, specify multiple payment methods during the payment creation process in a similar manner as shown above.

Example parameter:

"paymentMethodTypes": [
     "card",
     "pix",
     "ame",
     "paypal" 
  ]

API-Direct

The API-Direct integration mode enables our PCI-compliant partner to facilitate local payment methods in server-to-server payment processing.

1. Create PaymentMethod

Example request:

POST  https://api.moneycollect.com/api/services/v1/payment_methods/create
{
  "billingDetails": {
    "address": {
      "city": "Asheville",
      "country": "US",
      "line1": "3968 Fidler Drive",
      "line2": "",
      "postalCode": "28806",
      "state": "North Carolina"
    },
    "email": "funny@moneycollect.com",
    "firstName": "Mark",
    "lastName": "Merrill",
    "phone": "6533714563"
  },
  "card": {
    "cardNo": "",
    "expMonth": "",
    "expYear": "",
    "securityCode": ""
  },
  "pix": {
    "taxId": "11032341882"
  },
  "boleto": {
    "taxId": "11032341882"
  },
  "type": "pix"   
}

Example response:

{
	"code": "success",
	"msg": "success",
	"data": {
		"id": "pm_17543443642xxxxx",
		"type": "pix",
		"billingDetails": {
			"firstName": "Mark",
			"lastName": "Merrill",
			"phone": "6533714563",
			"email": "funny@moneycollect.com",
			"address": {
				"city": "Asheville",
				"country": "US",
				"line1": "3968 Fidler Drive",
				"line2": "",
				"postalCode": "28806",
				"state": "North Carolina"
			}
		},
		"created": "2022-02-04T07:20:49.363Z",
		"customerId": null,
		"card": null,
		"boleto": null,
		"pix": null
	}
}

2. Create a Payment

Example request:

POST https://api.moneycollect.com/api/services/v1/payment/create
{
  "amount": 990,
  "currency": "USD",
  "orderNo": "SGUJDAU0-0005",
  "notifyUrl": "https://notifyUrl",
  "returnUrl": "https://returnUrl",
  "ip": "14.153.236.144",
  "paymentMethod": "pm_17543443642xxxxx",
  "paymentMethodTypes": [
    "pix"
  ],
  "confirm": true,
  "website": "https://fanyi.baidu.com"
}

Example response:

{
	"code": "success",
	"msg": "success",
	"data": {
		"id": "pt_1754346087365287938",
		"amount": "990",
		"currency": "USD",
		"paymentMethod": "pm_1754346064963510273",
		"paymentMethodTypes": [
			"pix"
		],
		"paymentMethodType": "pix",
		"notifyUrl": "https://notifyUrl",
		"returnUrl": "https://returnUrl",
		"website": "https://fanyi.baidu.com",
		"ip": "14.153.236.144",
		"clientSecret": "pt_1754346087365287938_secret_42A78177CEEBB8A60CE629FD4A99648B",
		"created": "2022-02-05T03:27:56.062Z",
		"nextAction": {
			"type": "redirect",
			"redirectToUrl": "https://checkout.xxx.com/checkout?prepay_id=QVViS0N5Znh1dzVXZzxxxxxx"
		},
		"status": "requires_action",
		"displayStatus": "pending",
		"errorCode": null,
		"errorMessage": null,
		"invoiceId": null,
		"fromChannel": null,
		"use3D": false
	}
}

3.Redirecting to Payment Page

After creating a payment, use the redirectToUrl from the response to redirect customers to the payment page of the local payment institution to complete the transaction.

4. Completing the Payment

Customers will be redirected to the local payment institution's page, where they can scan a QR code or enter the necessary payment information to finalize the payment.

Special Handling APMs (Wechat Pay/Kakao Pay)

Wechat Pay

first and obtain the Payment Method ID for the next step.

Use the type parameter to specify the payment method code you wish to use. The payment method code list can be retrieved from the on MoneyCollect's documentation. Please make sure that the payment method has been applied and approved in your dashboard before using it in the production environment.

Use the Payment Method ID obtained in the previous Create PaymentMethod step to initiate the request.

Create a paymentMethod
Supported APM codes and attributes list
Create a Payment
Apply for APMs from your dashboard - MoneyCollect Documentation
Create a Session | MoneyCollect API Reference V1.0
Supported APM codes and attributes list
737KB
微信支付对接文档.pdf
pdf